Swagger UI - добавить пример curl с отключенной кнопкой "попробовать"

#swagger-ui

Вопрос:

Я использую Swagger UI для создания документов для пользовательского REST API.

Я отключил кнопку «Попробовать», так как она мне не нужна, но я бы хотел показывать команду curl для каждого запроса.

Есть ли способ показать это, не активируя кнопку «попробовать»? Или, может быть, добавить что-то в файл YAML, который показывает еще один div с пользовательским текстом в нем?

Ответ №1:

Есть ли способ показать это, не активируя кнопку «попробовать»?

Нет. Генератор команд curl Swagger UI зависит от доступности «попробовать», поскольку команды генерируются на основе конкретных значений параметров, которые пользователь указал во время «попробовать».

Или, может быть, добавить что-то в файл YAML, который показывает еще один div с пользовательским текстом в нем?

Вы можете добавить использование description поля операций для добавления деталей, таких как примеры кода. Описания поддерживают Markdown для форматирования расширенного текста.

 paths:
  /something:
    get:
      summary: Get something
      description: >-
        Detailed description goes here.


        And here's some code:

            curl https://example.com/something -H "Accept: application/json"

      responses:
        200:
          description: Successful response