Вопросы по теме 'openapi'
Как определить разные параметры тела для одного и того же пути в OpenAPI (Swagger)?
У меня есть служба, которая может иметь два разных типа параметров тела на основе заголовка Content-Type .
Например. для пути /Pet :
Если используется Content-Type: application/somecustom.resource+json , то POST может принимать Pet в...
2741 просмотров
schedule
13.06.2023
Как указать, является ли поле необязательным или обязательным в OpenAPI / Swagger?
Как определить в OpenAPI / Swagger, является ли поле необязательным или обязательным, а какое - по умолчанию?
67368 просмотров
schedule
31.01.2023
Конечные точки Google Cloud - метод не существует - спецификация OpenAPI yaml
Я пытаюсь настроить NodeJS REST API с помощью конечных точек Google Cloud и Google App Engine. Я клонировал официальный образец проекта с GitHub и настройте конечные точки Google Cloud с помощью Quickstart . Из коробки он работает нормально, но я...
1056 просмотров
schedule
22.02.2022
Что на самом деле означает «требуется» в OpenAPI
Учитывая следующее определение OpenAPI, какие из перечисленных ниже объектов являются допустимыми. Просто 1. или 1. и 2.?
Person:
required:
- id
type: object
properties:
id:
type: string
{"id": ""}
{"id": null}...
11848 просмотров
schedule
09.03.2024
Включение Swagger (метаданные OpenAPI 2.0) для функций Azure
В настоящее время я слежу за документацией azure, чтобы включить документацию swagger для функций azure, но в настоящее время я застрял на Включение поддержки определений API
Нужно ли мне что-то изменить в приложении-функции Azure, чтобы увидеть...
613 просмотров
schedule
08.04.2023
Спецификация Swagger / OpenAPI для массивов объектов в параметре запроса URL
Предположим, у меня есть URL-адрес, который имеет путь: ?filter[id]=1&filter[name]=bob&order[][name]=asc&order[][age]=desc
Как можно было бы преобразовать это в чванливую документацию, в частности, массив объектов и массивов в...
1229 просмотров
schedule
25.08.2022
Как вручную определить перечисление, генерируемое кодогенерацией Swagger?
Я создаю SDK с использованием кодогенератора Swagger, и мне нужно сгенерировать метод, который будет принимать перечисление в качестве параметра. Мое перечисление уже определено, теперь мне нужно настроить параметры моей операции. Мне удалось...
444 просмотров
schedule
17.02.2022
Типы динамических свойств в спецификации Swagger
Можно ли определить свойства в определении Swagger/OpenAPI, которые могут быть одного из двух типов.
Например, наш API позволяет отправлять идентификатор источника в виде строки или исходного объекта. Исходный объект имеет фиксированную схему:...
458 просмотров
schedule
26.01.2024
Как наследовать свойства схемы от другой схемы?
Я использую ReDoc для визуализации документации API с использованием JSON-файла OpenAPI 2 (Swagger). Я пытаюсь объявить два входных параметра запроса, включив первую схему во вторую следующим образом:
...
"definitions": {
"list-request": {...
476 просмотров
schedule
14.05.2022
Пример данных, унаследованных Open API
Я использую OpenAPI 3.0 для определения API для сервиса, который я создаю. Я столкнулся с проблемой повторного использования компонентов схемы внутри других компонентов. Например, у меня есть объект Note , который содержит объект Profile...
860 просмотров
schedule
18.09.2022
Можете ли вы предложить действительно хорошую документацию для добавления google+ OAuth2 в документ openapi v3, работающий в swagger-ui?
Базовая аутентификация отлично работает в моем документе openapi v3, работающем в swagger-ui. Теперь я хочу добавить аутентификацию Google+ oauth2. Можете ли вы указать мне хорошую документацию для новичков, как это сделать?
Я нахожу параметры...
249 просмотров
schedule
09.08.2023
как разрешить использование более одного типа свойства с помощью Swagger?
Я использую Swagger, один из инструментов Open API для определения API.
Например, у меня есть объект NameValue { propertyName: propertyValue}
Как разрешить Sagger разрешать propertyValue может быть целым числом, строкой, логическим...
72 просмотров
schedule
19.11.2023
Использование «по умолчанию» с «обязательными» параметрами для OpenAPI
В документации говорится:
Использование default с required параметрами или свойствами, например, с параметрами пути. Это не имеет смысла — если требуется значение, клиент всегда должен его отправить, а значение по умолчанию никогда не...
1368 просмотров
schedule
22.11.2023
Swagger / OpenAPI 3.0 RequestBody Описание не показано
Сегодня попробовал себя в создании API-документации в Swagger. Я напрямую пробовал openapi 3.0. Я почему-то не могу получить описание работы моего тела запроса.
requestBody:
content:
application/x-www-form-urlencoded:
schema:...
2960 просмотров
schedule
23.12.2022
Как избежать ошибок CORS (не удалось получить или сервер не найден или произошла ошибка) при выполнении запросов из редактора Swagger?
У меня есть следующее определение OpenAPI:
swagger: "2.0"
info:
version: 1.0.0
title: Simple API
description: A simple API to learn how to write OpenAPI Specification
schemes:
- https
host: now.httpbin.org
paths:
/:
get:...
10422 просмотров
schedule
10.10.2022
как определить динамические заголовки в шаблоне пользовательского соединителя Azure
Параметры заголовка в шаблоне logicApp можно динамически добавлять несколько раз, но мне нужны те же функции в моем пользовательском шаблоне коннектора. Я не могу найти учебник или документы для этого.
Это мой пользовательский коннектор,...
183 просмотров
schedule
28.01.2023
Как удалить тело ответа операции в Springfox Swagger?
Я работаю в службе REST, созданной с помощью spring -boot, которая до сих пор документирована с помощью springfox-swagger2: 2.7.0 (сначала реализация). Последняя добавленная мной операция выглядит так:
@ApiOperation(value = "whatever")...
5411 просмотров
schedule
24.02.2023
Как я могу сравнить пути, определения, параметры и ответы между двумя документами OpenAPI / Swagger json API?
Я хотел бы узнать, есть ли решение, которое поможет найти различия между двумя разными версиями API одного и того же продукта (Swagger / Open API 2.0). Например, этот инструмент: https://github.com/Sayi/swagger-diff сравнивает параметры, ответы,...
296 просмотров
schedule
13.03.2022
QueryParam объявлен как необязательный в Swagger API
Я реализовал ресурс Jax-RS (используя Dropwizard), который содержит этот метод:
import javax.ws.rs.DefaultValue;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.QueryParam;
import...
2136 просмотров
schedule
06.06.2024
Как правильно ссылаться на пример в компонентах (OAS 3.0)
Я следовал спецификации OAS 3.0. чтобы написать свой документ в YAML, но результат, отображаемый редактором Swagger, искажен.
Объект responses под некоторым объектом operation
responses:
200:
description: "..."...
157 просмотров
schedule
01.09.2023
