Вопросы по теме 'swagger-editor'
Как указать POST с телом JSON в редакторе Swagger
у меня есть метод POST REST API с телом запроса как json, который имеет
{
"name": "5-Star",
"vendor": "Cadbury",
"description": "More almonds with chocolate",
"price": 5,
"primaryImage":...
2621 просмотров
schedule
12.05.2022
Аннотации Swagger и спецификация Swagger 2.0
Я разработал REST API с аннотациями Swagger. Мне удалось показать документацию api в приложении swagger-ui, очень приятно.
Проблема: я пытаюсь создать клиентов в соответствии с этой спецификацией, используя URL-адрес, предоставленный swagger в...
2170 просмотров
schedule
01.07.2023
Swagger выдает ошибку Swagger. Недопустимое определение параметра для параметра body.
Это мой вклад:
parameters:
- name: body
in: body
required: true
type: object
description: |
The body.
schema:
$ref: '#/definitions/CsrRequest'
И это говорит следующее:
Подробности...
8884 просмотров
schedule
18.05.2023
Можно изменить имя пакета при генерации клиентского кода
Я создаю клиентский код scala для API, используя Swagger Edtior. Я вставил json, затем сделал Generate Client/Scala. Это дает мне корневой пакет по умолчанию
io.swagger.client
Я не вижу никакого очевидного способа указать что-то другое....
10728 просмотров
schedule
18.09.2022
Swagger генерирует код сервера Node.JS Express
У меня есть документация по Swagger 2.0, и я хотел бы создать заглушку сервера Node.JS на основе существующей спецификации Swagger.
Когда я использую редактор Swagger , у него есть возможность генерировать заглушки сервера Node.js, но...
3507 просмотров
schedule
09.11.2022
Определение параметра словаря редактора Swagger
Я борюсь с тем, как определить тип словаря в редакторе swagger. Один из параметров моего метода POST называется «ролями», а его значение - это словарь, где ключ - это адрес электронной почты, а значение - целое число.
3493 просмотров
schedule
21.07.2023
Создайте определение непосредственно в объекте ответа
У меня есть это определение ошибки
"definitions": {
"error": {
"description": "The error",
"properties": {
"code": {
"description": "The code.",
"type": "string"
},...
82 просмотров
schedule
16.02.2023
Используйте ключевое слово безопасности имя свойства в определении в Swagger 2.0
У меня есть объект в моем разделе определений, который должен иметь свойство с именем security, но когда я это делаю, редактор swagger выдает мне сообщение об ошибке:
Семантическая ошибка в определениях.User.properties.security.properties...
3798 просмотров
schedule
27.08.2022
Как определить параметры path и formData для одной и той же операции в OpenAPI 2.0?
У меня есть конечная точка загрузки изображений, которая выглядит как /test/{id}/relationships/image . Я хочу описать эту конечную точку с помощью OpenAPI 2.0 (Swagger 2.0).
Конечная точка имеет параметры пути и formData. Я пробовал следующее:...
10966 просмотров
schedule
18.05.2023
Как ввести данные для вложенных массивов в пользовательском интерфейсе Swagger
Я создаю веб-api, используя asp.net webapi 2, и для своей документации я выбрал чванство.
Проблема, с которой я столкнулся, заключается в том, что один из моих методов api принимает вложенный массив (массив строк внутри другого массива). При...
4573 просмотров
schedule
12.03.2022
Синтаксис Swagger: как сослаться на определение модели из многоразового ответа
Здесь новичок в чванстве. Я прошел через праймер swagger a> и насколько я могу судить, мой пример ниже должен работать.
Мои типы ответов - это просто массивы различных структур (эти структуры определены в разделе глобальных определений, чтобы...
1011 просмотров
schedule
16.03.2024
Есть ли способ использовать несколько файлов yml с nelmio_api_doc в symfony 3 с NelmioApiDocBundle?
NelmioApiDocBundle позволяет использовать только один файл конфигурации в формате .yml.
nelmio_api_doc:
routes:
path_patterns: # an array of regexps
- ^/api
documentation:
paths:
/api/login_check:
......
1852 просмотров
schedule
01.05.2024
Как мы можем указать несколько типов элементов в массиве swagger?
Мы хотим иметь вложенный массив нескольких типов (строка, целое число, число с плавающей запятой).
Ниже приведен фрагмент yaml, который я хочу иметь
definitions:
A:
type: object
required:
- data
-...
2466 просмотров
schedule
24.07.2022
Документ API создания Swagger: редактор Swagger
Я использую чванство для документирования моей службы REST API. У меня есть конкретный вклад, который я предоставляю службе. Я сам создаю код YAML с помощью редактора swagger. Проблема, с которой я столкнулся, заключается в том, что я не могу...
324 просмотров
schedule
24.02.2022
Удалить спецификацию зоомагазина при запуске редактора swagger
Я использую Swagger Editor локально на своей машине.
Когда я запускаю редактор Swagger, он по умолчанию показывает спецификацию для зоомагазина при запуске.
Я хочу удалить это и показать пустой редактор. Есть ли способ сделать это при запуске.
6096 просмотров
schedule
06.07.2022
OpenAPI 3.0 - все внутри oneOf
Следующий YAML:
openapi: 3.0.0
info:
title: test
version: 1.0.0
paths:
/test:
get:
summary: test
responses:
'200':
description: Test
content:
application/json:
schema:...
2193 просмотров
schedule
19.03.2023
API-документ swaggerhub для той же конечной точки, но с разными ролями
Как я могу определить одну и ту же конечную точку с разными ролями в документации API swaggerhub.
/register:
post:
summary: Creates a new Driver.
requestBody:
required: true
content:
application/json:...
55 просмотров
schedule
02.03.2023
Swagger показывает дополнительные параметры в теле запроса
Мы используем springfox-swagger-ui и springfox-swagger2 версии 2.7.0.
Пост API имеет следующую подпись:
@ApiOperation("Edits information about employees")
@PostMapping(path = "/employee/edit", headers = EndPoints.VERSION_1)
@ApiResponses(value...
232 просмотров
schedule
27.11.2023
Отключить создание сервера/клиента в редакторе Swagger
После каждого запуска редактора Swagger API javascript отправляет два HTTP-запроса на
https://generator.swagger.io/api/gen/servers
https://generator.swagger.io/api/gen/clients
для отображения разделов навигации Generate server и...
138 просмотров
schedule
11.03.2023
Формат файла OpenAPI 3.0 дает ошибку вокруг разрешенных значений в параметрах
У меня есть спецификация API, указанная в OAS 3.0
post:
tags:
- One Time Payment
summary: One Time Payment API
operationId: oneTimePaymentUsingPOST
parameters:
- in: body
name: realTimePaymentRequest
description:...
1670 просмотров
schedule
09.05.2023
