vidra/swagger-doc-generator repository overview

⁠Docker Swagger doc generator

Validate your Swagger/OpenAPI spec file with docker.

⁠Usage

docker run -it --rm -v /your/file/dir:/apis  vidra/swagger-doc-generator:1.0.0 api.yaml

⁠Parameters

• Replace /your/file/dir with your local directory where the api spec file is. If the file is in the current directory use -v `pwd`:/apis, or if in a subdirectory -v `pwd`/subdir:/apis.
• Replace API spec filename api.yaml with yours that is placed inside the abode directory (optional, default it'll look for api.yaml).

⁠Why

Because you should generate API docs during tests/build. The docker run command will return a non-zero exit code if the generation fails: it fits nicely in your continuos integration process.

⁠License

GPL v3