swagger - Generar documentos estáticos con arrogancia

swagger tags

Question

¿Hay algún método para crear documentación estática para swagger 2.0? Tal vez como la ''vista previa'' en editor.swagger.io.

Necesito obtener archivos html estáticos para poder incluirlos en algunos documentos estáticos.

Hasta ahora no he encontrado una manera de hacer esto. Veo que hay documentos estáticos swagger-codegens pero esto solo funciona para swagger <= 1.2.

Answer 1

Utilice swagger-codegen:

swagger-codegen generate -i <path to your swagger file> -l html2 -o <path to output location>

Si decide personalizar la plantilla HTML:

1. Clona el proyecto swagger-codegen de github
2. Copie los modules/swagger-codegen/src/main/resources/htmlDocs2 carpeta modules/swagger-codegen/src/main/resources/htmlDocs2 a otro lugar, por ejemplo: cp -R modules/swagger-codegen/src/main/resources/htmlDocs2 ~/templates
3. Modifique las plantillas de .mustache en ~/templates para que se ajusten a sus requisitos.
4. Ejecutar: swagger-codegen generate -i <path to your swagger file> -l html2 -o <path to output location> -t <templates path> para <templates path> debe ser ~/templates en el ejemplo anterior.

Answer 2

He utilizado el procedimiento descrito aquí http://ics.upjs.sk/~novotnyr/blog/2156/create-html-documentation-from-swagger-via-maven .

Utiliza Maven para generar documentación estática y el resultado es bastante legible. Parece ser altamente configuarable y extensible, aunque aún no lo he probado.

Answer 3

Incluye la dependencia de swagger en tu pom.

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>

Y trata de golpear -> https://editor.swagger.io/

Answer 4

Los documentos estáticos en 2.0 están implementados para 2.0. vea el archivo ./bin/static-docs.sh aquí:

https://github.com/swagger-api/swagger-codegen/tree/master/bin

Answer 5

Puedes usar:

• swagger-ui : acaba de clonar el proyecto y copiar tu JSON en el directorio base
• github

Answer 6

Si está buscando específicamente Swagger 2.0, me gustaría indicarle mi respuesta en la especificación Converting Swagger JSON a la documentación en HTML , aunque creo que Swagger-Codegen ya soporta Swagger 2.0.

Answer 7

Si solo desea generar documentos estáticos de manera directa, considere Spectacle .

npm install spectacle-docs si quieres poner un script en tu package.json , o npm install -g spectacle-docs si debería estar disponible en todas partes.

A continuación, puede ejecutar spectacle spec.yaml , con opciones para compilar en un directorio específico, ejecutar un servidor y / o mirar el archivo de especificación y actualizar según sea necesario.

Answer 8

documentos "estáticos" pueden significar varias cosas.

Si está buscando una pantalla interactiva (como la vista previa del editor), tiene swagger-ui ( https://github.com/swagger-api/swagger-ui ).

El código en el codegen que hace los documentos más estáticos (sin el botón "Pruébelo ahora", por ejemplo) aún no está implementado para 2.0, aunque debería estar disponible en las próximas semanas.