Sign inSign up

ryutah/swagger-document

By ryutah

•Updated about 8 years ago

Generate API document from swagger file.

Image
1

2.6K

ryutah/swagger-document repository overview

⁠Swagger API HTML Generator

Generate API document from swagger file.

example

⚠Does not support OpenAPI 3.0 format⚠

This tool is based on this article⁠

⁠Usage

$ docker run \
  -v {SWAGGER_FILE_DIRECTRY}:{MOUNT_PATH} \
  ryutah/swagger-document {SWAGGER_FILE_PATH} {OUTPUT_FILE_PATH}
⁠example

Generate document named sample.html in current directory from swagger definition file named swagger.yaml in same directory.

$ docker run \
  -v $(pwd):/work \
  ryutah/swagger-document /work/sample.yaml /work/sample.html

⁠Example

https://ryutah.github.io/docker-swagger-document/⁠

Tag summary

Content type

Image

Digest

Size

171.4 MB

Last updated

about 8 years ago

docker pull ryutah/swagger-document