ocular-d / api-cli Goto Github PK

OpenAPI Documentation Tooling
Explore the docs »

Report Bug · Request Feature

• About the Project
• Perquisites
• Getting Started
• Contributing
• License
• Credits

Wrapper around OpenAPI 3 CLI and ReDoc-CLI.

For now we use a fix naming schema and directory structure.

This may change in the future (PRs are welcome).

docker run -it --rm -v `pwd`/spec:/app/spec -p 8080:8080 testthedocs/api-cli api:preview

Open your browser and navigate to http://localhost:8080

docker run -it --rm -v `pwd`/spec:/app/spec -p 8080:8080 testthedocs/api-cli api:bundle

This will bundle your openapi.json into a standalone index.html file.

We are a community effort, and everybody is most welcome to participate!

Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.

• MIT