Вопросы по теме 'swagger-editor'
Спецификация Swagger в Swagger Core Jersey 1.X
Я использую Swagger с Jersey 1. Он генерирует спецификацию в спецификации Swagger v1.2. Для большинства инструментов (например, Editor ) требуется спецификация версии 2.0. Есть ли способ создать спецификацию v2.0?
На самом деле мне нужны были...
185 просмотров
schedule
26.10.2022
Сделать добавление элемента захвата схемы модели по запросу поля массива
Я делаю адаптер для REST API. Я использовал схему модели для тела метода POST и PUT. @RequestBody Model1 requestBody на адаптере.
Теперь я столкнулся с body с полями, для которых требуется массив .
Ввод тела пользовательского интерфейса...
249 просмотров
schedule
12.09.2022
Как исключить проверку ответа API swagger для изображений?
У меня есть функция Swagger YAML, например:
/acitem/image:
x-swagger-router-controller: image_send
get:
description: Returns 'image' to the caller
operationId: imageSend
parameters:
- name: name...
1120 просмотров
schedule
18.10.2022
Создание сложных типов (определений) в Swagger
Я создал определение под названием Product и другое под названием Text (см. код).
На parameters из paths не могу использовать тип Text созданный в определениях. В определении Product у меня есть свойство с именем message , и я хочу,...
10305 просмотров
schedule
13.02.2023
Ссылка на параметры в определении той же причины файла вызывает ошибку Swagger
Я пытаюсь сослаться на некоторые параметры, которые я использую в нескольких путях, в разделе определения файла swagger yaml, и хотя документация отображается должным образом и запросы создаются правильно, при использовании кнопки try it out я...
591 просмотров
schedule
29.08.2022
Как указать подмножество свойств модели в документации по маршруту API swagger
Работаю над написанием спецификации API для моего сервиса с помощью swagger. Я использую определение модели ("#/definitions/prototype") в качестве параметра тела маршрутов POST /prototypes и PATCH /prototypes/:id .
Как указать, что маршрут...
1405 просмотров
schedule
26.08.2023
Пользовательский интерфейс Swagger - не удается включить редактор JSON для тела запроса
У меня есть проблема, чтобы заставить его работать, по следующей ссылке ниже, редактор JSON для тела запроса (по умолчанию отключен).
https://github.com/jensoleg/swagger-ui
Как я могу включить его?
2358 просмотров
schedule
18.10.2022
Шлюз API и пользовательский интерфейс Swagger
В настоящее время у меня есть API с несколькими ресурсами в нашем шлюзе API, я работаю над страницей пользовательского интерфейса Swagger для того же.
Многие определения пользовательского интерфейса swagger я написал сам, хотя я знаю, что есть...
1782 просмотров
schedule
14.09.2022
Используйте Oauth в Swagger API
Я создаю API с помощью swagger, и до сих пор я создавал задания для получения/вставки/обновления и удаления, и теперь я пытаюсь использовать Oauth для защиты своего API.
я использовал
securityDefinitions:
job_auth:
type: oauth2...
443 просмотров
schedule
24.09.2022
Подобные пути к редактору Swagger
У меня есть два отдельных пути, определенных в моей схеме:
/team/{id}/people/{modified}:
get:
/team/{id}/people/{person_id}:
delete:
Итак, это две совершенно разные «вещи», потому что одна — это получение, а другая — удаление, а имя...
118 просмотров
schedule
12.12.2022
Swagger Nodejs - Ошибка проверки ответа
Я создаю API с помощью Swagger и NodeJS, досадная проблема, с которой я столкнулся до сих пор, заключается в том, что Swagger проверяет ответ, и это не всегда гладко.
Мое дело:
В файле .yaml: я проверил синтаксис yaml с помощью Swagger Editor =>...
4588 просмотров
schedule
10.05.2023
Исключить свойство из схемы [Swagger]
У меня есть схема Foo с полями a , b и c . c — это массив, который не возвращается, когда я делаю GET /foos , но возвращается, когда я делаю GET /foos/{foo_id} .
Как я могу представить это с помощью схемы чванства? (поле c...
1739 просмотров
schedule
23.11.2023
Как форматировать блоки кода в описаниях в Swagger UI 3.x?
Я хотел бы поместить блок кода Markdown в описание моего API, но пользовательский интерфейс Swagger, похоже, читается так, как будто это фрагмент кода из одной строки. В настоящее время у меня есть:
description: |
This API was created to...
1759 просмотров
schedule
16.08.2022
Описание перегрузки в файле Swagger (YAML)
У меня проблема с записью файла swagger. Когда я описываю параметр, описание перегружается описанием $ref этого же параметра (см. пример ниже).
a-body:
description: The body
type: object
properties:
my_param:...
492 просмотров
schedule
31.07.2022
Ошибка схемы Swagger при попытке использовать
У меня ошибка, аналогичная Ошибка схемы Swagger НЕ должна иметь дополнительных свойств , но в моем случае я ссылаюсь на # / definitions, поэтому был бы признателен за помощь.
Я попытался создать явный объект:
responses:
'200':...
1570 просмотров
schedule
03.07.2022
Измените имя пакета по умолчанию в редакторе Swagger для проекта Java.
Я скачал Swagger Editor и запустил его локально с localhost:3001 . Я импортировал свой файл .yaml из локальной системы. Затем я нажал на Generate Server и выбрал jaxrs . Когда я открыл случайный java-файл, я вижу:
package...
3386 просмотров
schedule
24.11.2022
точное значение по умолчанию в определении чванства
Вот мой черновик кода для API, главное — это часть определения:
definitions:
Code:
type: object
properties:
code:
type: string
Status:
type: object
properties:
status:
type: string
externalDocs:...
27 просмотров
schedule
03.04.2024
Включить редактор Json с помощью Swagger-UI
Как я могу использовать редактор Json, используя следующий github ( https://github.com/jensoleg/swagger-ui )?
Какие коды мне нужно использовать, чтобы включить редактор JSON для тела запроса?
Пытался изменить свой код, но он не работает для...
687 просмотров
schedule
29.03.2023
Я столкнулся с проблемой в API Swagger?
Swagger.yml
swagger: "2.0"
info:
version: "0.0.1"
title: Movie DB
# during dev, should point to your local machine
host: localhost:8000
# basePath prefixes all resource paths
basePath: /
#
schemes:
# tip: remove http to make...
163 просмотров
schedule
14.07.2023
Swagger экранирует косую черту в параметрах пути
Некоторые из моих API используют путь к файлу в качестве параметра пути (например, .../hello/test.txt), который будет включать косую черту. Однако в Swagger он всегда избегает косой черты, так что мой предполагаемый URL-адрес...
1132 просмотров
schedule
25.06.2022
