swagger-codegen

swagger Как сгнерировать HTML страницу c документацией (напр. из yaml)

Предположим, что yaml с информацией о метода вы генерировать уже уже научились и теперь нам надо перегнуть его в html.

Наиболее простым способом является (но не самым быстрым и удобным):

  1. взять сгенерированный yaml
  2. добавить его слева в область кода на https://editor.swagger.io/
  3. и далее из главного меню:
    Generate Client -> html2

    качаем получившийся html и наслаждаемся)

JsonParseException: Unrecognized token 'openapi' Ошибка при генерации документации swagger-codegen

JsonParseException: Unrecognized token 'openapi'

В ответ на команду:

java -jar swagger-codegen-cli.jar generate -i /var/www/myproject/openapi.yaml -l  php

При этом файл (openapi.yaml), который генератор должен парсить выглядит так:

openapi: 3.0.0
info:
  title: 'API'
  version: 1.0.0
paths:
  /v1/api/campaign-types:
    get:
      operationId: getUserByName
      responses:
        '200':
          description: 'Список типов компаний'

Решение

Subscribe to RSS - swagger-codegen