Вопросы по теме 'openapi'
Как указать несколько причин 404 в OpenAPI (Swagger)?
Я определяю путь для вложенного ресурса (контента, принадлежащего доставке). Если клиент получает ошибку 404, это может быть связано либо с тем, что идентификатор доставки не был найден, либо потому, что доставка не содержала какого-либо содержимого...
5927 просмотров
schedule
14.04.2023
_link модель - HATEOAS
Меня попросили внедрить HATEOAS как часть нашего rest API, и именно так ответ определяется в спецификациях Swagger.
_links:
[
{
rel:
string
The relationship to the request e.g. self which contains the resource that was requested or {object...
568 просмотров
schedule
17.03.2023
Предоставление документации Swagger-UI через Google Cloud Endpoints
Я пытаюсь опубликовать свои документы API в том же приложении Nodejs, что и мой API, используя конечные точки Google Cloud.
Следуя этому руководству, все выглядит просто: Добавление пользовательского интерфейса Swagger
Сложная часть...
1160 просмотров
schedule
15.09.2022
Многострочный пример в теле ответа openapi v3
Есть ли способ закодировать многострочный пример в теле запроса? Если возможно, я бы хотел, чтобы мой документ OpenApi отображался следующим образом при работе под Swagger-UI.
До сих пор все, что мне удалось сделать, это однострочный...
1860 просмотров
schedule
15.11.2023
Отправка информации о рабочем процессе в настраиваемый соединитель
Мне нужна помощь с отправкой информации о рабочем процессе в заголовке / теле вызовов на настраиваемый коннектор. Я пытаюсь загрузить раскрывающийся список в одном из параметров приложения логики, используя значения, возвращенные из вызова API....
205 просмотров
schedule
22.03.2023
Есть ли способ сгенерировать swagger.json из файла json-server
Для прототипирования мы используем библиотеку json-server, которая создает поддельный REST api на основе нашего файла db.json. Теперь мы хотели бы использовать чванство.
Итак, мой вопрос: есть ли способ сгенерировать swagger.json из нашего файла...
3225 просмотров
schedule
21.08.2022
Как определить массив другой схемы в OpenAPI 3?
Я определил эту схему:
User:
type: object
required:
- id
- username
properties:
id:
type: integer
format: int32
readOnly: true
xml:
attribute: true
description: The user ID
username:...
5282 просмотров
schedule
19.04.2022
swagger core 2.0 отключить безопасность для конечной точки
Я использую Swagger Core 2.0 для создания файлов определений openAPI 3.0, и у меня возникли проблемы с отключением «безопасности» для конкретной конечной точки. У меня определены мои securitySchemes и корневой элемент безопасности:
{
"openapi"...
1706 просмотров
schedule
14.05.2022
Какую структуру папок создает Swagger Codegen для OpenAPI 3.0?
Какова структура файлов / папок по умолчанию, созданная Swagger Codegen для определений OpenAPI 3.0?
945 просмотров
schedule
25.02.2023
Может ли кто-нибудь определить ошибку для меня в этом файле YAML?
Я не могу найти ошибку из того, что он мне говорит:
243
should match exactly one schema in oneOf
244
should be equal to one of the allowed values allowedValues: query, header, cookie
Ошибка 244 действительно странная, поскольку он...
347 просмотров
schedule
14.06.2022
Почему Swagger Codegen дает класс конфигурации, не загружающий ошибку при работе с java?
Я пытаюсь использовать Swagger Codegen из кода Java для автоматического создания API весной следующим образом:
String[] args = new String[4];
args[0] = "generate";
args[1] = "-i swagger.json";
args[2] = "-l spring";
args[3] = "-o output";...
911 просмотров
schedule
08.04.2022
Аннотации Swagger 2 — пример осмысленной схемы для карт
Это почти то же самое, что другой вопрос для Swagger 1 , за исключением того, что это связано с Swagger 2.
Короче говоря, у меня есть реализация, которую я пытаюсь аннотировать, чтобы создать спецификацию OpenApi 3. У одной из моделей есть...
2046 просмотров
schedule
16.02.2023
Должен ли мой API вкладывать данные JSON в родительский объект?
Сегодня меня назвали «непрофессионалом», потому что я не вложил свой ответ JSON в родительский объект.
GET /users/{id} отвечает так:
{
"username":"atr217",
"age":35,
...
}
Они ожидали этого:
{
"user":{...
1119 просмотров
schedule
13.11.2022
Генерация документов swagger из интерфейсов typescript
Я использую swager-jsdoc для документирования всех DTO приложения.
Мне было интересно, есть ли способ автоматически генерировать документы swagger из интерфейсов машинописного текста.
У меня их много в проекте, а также много схем и моделей...
4127 просмотров
schedule
11.07.2022
Как потребовать хотя бы один из двух параметров в OpenAPI?
Я использую OpenAPI 3 и имею два параметра запроса, по крайней мере, один из которых требуется, но не имеет значения какой.
То есть как судокод:
if parameter_1 OR parameter_2:
do stuff
else:
error
Возможно ли это в OpenAPI 3?...
5120 просмотров
schedule
01.08.2023
Как исправить ErrorException: @OA\Items() требуется, когда @OA\Property() имеет тип массива?
Я попытался добавить вложенный массив произвольных типов. Это мои аннотации:
* @OA\Property(
* @OA\Schema(
* type="array",
* @OA\Items(
* type="array",
* @OA\Items(type={})
* )
* ),
*...
7474 просмотров
schedule
13.09.2022
Как указать схему повторно используемого параметра тела запроса в OpenAPI 3.0
Сайт swagger docs показывает пример для этого случая, но не пройдите до конца, чтобы показать определение схемы Pet .
E.g.:
paths:
/pets:
post:
summary: Add a new pet
requestBody:
$ref:...
2065 просмотров
schedule
04.05.2023
Попытка включить swagger-codegen с gradle kotlindsl
Я пытаюсь заставить swagger codegen работать в проекте, созданном с помощью gradle (kotlin).
Я ссылаюсь на этот пример здесь: https://github.com/int128/gradle-swagger-generator-plugin , выполненный в версии Gradle groovy .
Теперь...
1775 просмотров
schedule
01.02.2023
ModuleNotFoundError в связи
У меня есть спецификация OpenAPI 3.0 , и я хочу использовать ее с Connection для запуска службы Python.
Соответствующая часть спецификации API находится здесь:
paths:
/find:
post:
summary: XXX
description: XXX...
4057 просмотров
schedule
21.12.2022
Взаимоисключающие свойства в чванстве
Как мне указать, что в my_object у вас может быть свойство_1 или свойство_2, но не оба?
my_object:
type: object
properties:
property_1:
type: string
property_2:
type: string
1455 просмотров
schedule
22.09.2022
