Тело запроса не отображается в примере curl с OpenApi3 + widdershins + shins - PullRequest
0 голосов
/ 10 октября 2019

Я создаю документацию API для наших конечных точек Java. Я использую widdershins для преобразования нашего yaml-файла openAPI3.0 в уценку. Затем я использую голени, чтобы преобразовать файл уценки в HTML. Тело запроса для всех наших конечных точек не появляется в сгенерированных примерах cURL. Почему это? Это противоречит цели иметь примеры cURL, потому что копирование и вставка примера cURL без необходимого тела не будут работать. Кто-нибудь может порекомендовать обходной или альтернативный инструмент, который генерирует хорошую документацию с полными примерами cURL?

Пример конечной точки из нашего файла openAPI.yaml ...

post:
  tags:
  - Tools
  description: Installs a tool on a user's account
  operationId: Install Tool
  requestBody:
    description: UserTool object that needs to be installed on the user's account
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/UserTool'
    required: true
  parameters:
  responses:
    default:
      description: default response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'

Это документация, которую генерирует наш набор инструментовиз этого файла yaml ... enter image description here Мы хотели бы добавить строку, аналогичную приведенной ниже (серая подсветка), в наши примеры cURL. Это фрагмент файла уценки, который Widdershins создает из нашего файла yaml openAPI. Я вручную добавил - «d

enter image description here

Это переполнение стека Q / A предполагает ответ, что невозможно включить параметр body в пример кода, используя swagger илиOpenAPI. Это верно? Если так, то почему это так? В чем причина?

Приветствия, Гедеон

...