Как сгенерировать API документацию с помощью openapi-генератора? - PullRequest
Новая
       59

Как сгенерировать API документацию с помощью openapi-генератора?

0 голосов
/ 14 января 2020

Я новичок в OpenAPI 3.0.0.

Я успешно создал клиентскую библиотеку java, используя openapi-generator .

Но OpenAPI Генератор позволяет создавать клиентские библиотеки API (генерация SDK), заглушки серверов, документацию. Поэтому я хочу знать, есть ли какие-либо команды или шаги, доступные для генерации HTML документации, а также для настройки шаблона документации.

1 Ответ

1 голос
/ 30 апреля 2020

Старый вопрос, но для тех, кто все еще сталкивается с ним. OpenApi Generator может генерировать html документацию из вашего yaml или json определения вашего API. 

openapi-generator generate -i PathToMyInputDefinitionFile.yaml -g html -o /PathToOutputFolder

Где html - генератор, который вы хотите использовать. Другие генераторы включают dynamic-html и html2. Также может излучать как уценку. См. https://openapi-generator.tech/docs/generators/

При использовании Docker полный пример будет выглядеть следующим образом: 

docker run --rm -v ${PWD}:/local openapitools/openapi-generator:tagname generate -i /local/input.yaml -g html -o /local

PWD представляет собой рабочий каталог (текущий каталог) в хост, который вы отображаете на / local в контейнере. Настройте 'tagname' в соответствии с https://hub.docker.com/r/openapitools/openapi-generator/tags Настройте input.yaml в качестве определения yaml входного файла для вашего API.

...