swagger-markdown
openapi
| swagger-markdown | openapi | |
|---|---|---|
| 1 | 2 | |
| 227 | 361 | |
| - | 1.9% | |
| 5.1 | 9.8 | |
| about 1 month ago | about 22 hours ago | |
| TypeScript | Ruby | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger-markdown
-
Generating docs from OpenAPI Spec
The first iteration involved adding a small build script to the docs repo that cloned the backend repo and used swagger-markdown on each file to generate markdown. Docusaurus found the markdown files and did the rest.
openapi
-
The Collison Brothers Built Stripe into a $95B Unicorn
I wonder if there is a format for API -> client automation that can be good enough, in the end Stripe have a rest API, with enough description it should be possible.
Okay so after a quick google it appears Microsoft are the "Simpsons already done it" of the programming world: https://github.com/Azure/autorest/
It'd probably be a good idea to add an Elixir backend for that and point it at Stripe's API here: https://github.com/stripe/openapi
-
Generating docs from OpenAPI Spec
Our specs were split between several YAML spec files. It looked like a good idea when we did that - large files are not fun to work with. The problem is that very little in the OpenAPI ecosystem was built for multiple files. I strongly recommend that you will save yourself the pain and go the mono-file route. If Stripe can have a 4.5MB spec file, so can we.
What are some alternatives?
swagger-cli - Swagger 2.0 and OpenAPI 3.0 command-line tool
cardano-python - Python module for handling Cardano cryptocurrency
redocly-cli - ⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
plutus-starter - A starter project for Plutus apps
Docusaurus - Easy to maintain open source documentation websites.
gifski-command - Node.js module for gifski GIF encoder CLI
widdershins - OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
docs-cardano-org - Documentation for Cardano