Как сгенерировать статический html-файл из документации swagger?

Question

Я создал документацию чванства с yaml файлом под:

api/swagger/swagger.yaml 

Теперь я хочу поделиться статическим HTML документом с его дефиницией, но это было указано на swagger project, что они не планируют поддерживать html поколения вообще.

Как создать статический html-файл из проекта swagger?

Answer 1

Существует swagger2markup-cli, который может генерировать статический файл adoc.

Убедитесь, что у вас установлена ​​среда выполнения Java. (Я использую среду выполнения Java (TM) SE Runtime (сборка 1.8.0_111-b14)).

Вы принести банку:

wget https://jcenter.bintray.com/io/github/swagger2markup/swagger2markup-cli/1.1.0/swagger2markup-cli-1.1.0.jar 

И вы можете создать статический adoc с ним через:

java -jar ~/your/path/swagger2markup-cli-1.1.0.jar help convert -i api/swagger/swagger.yaml --outputFile static-swagger 

Это Adoc файл может быть преобразован в html файл через asciidoctor:

asciidoctor *.adoc 

Возможно, вам потребуется установить его, поскольку Я использую Ubuntu, я мог бы с помощью:

sudo apt-get -qq install asciidoctor 

Answer 2

Самый простой способ, которым я могу думать о том, чтобы использовать Кураж Editor (https://editor.swagger.io)

1. Перейти к https://editor.swagger.io
2. Нажмите на «Файл» в и затем выберите «Файл импорта».
3. После импорта нажмите «Создать клиент» в верхней строке меню, а затем выберите «HTML» или «HTML2» для создания статической HTML-документации.

editor.swagger.io использует генератор.swagger.io для создания клиентов API, серверных заглушек и документации и генератора.swagger.io работает от проекта с открытым исходным кодом Swagger Codegen