We encourage all efforts in the OpenAPI ecosystem, and none of these tools are easy to create and maintain. That said, we don't want to be an exhaustive list of every single tool out there. OpenAPI.Tools is a curated list, which aims to help people find modern, reliable tooling, that's of as high quality as we can reasonably hope for.
Our focus on high-quality tooling means we cannot accept every tool that would like to be listed here, at least not right away. Submissions must align with the following guidelines:
- Real-world use: there should be evidence that people are using it, perhaps through package downloads, GitHub stars, or other means
- Testable: submissions should be released, and there should be a way of testing it so we can validate it works
- Relevant: all submissions must relate to the OpenAPI ecosystem and abide by its Code of Conduct
- Terminology: descriptions and language should follow the OpenAPI Glossary
We use jekyll so you should use ruby and install it using bundler.
$ bundle install
If you want to check changes, launch the jekyll server and open the browser.
$ bundle exec jekyll serve
- Edit
_data/tools.ymland copy/paste/tweak another tool. - Try and avoid using the word "Swagger" unless you work for SmartBear and are literally talking about the Swagger toolsuite. It's been called OpenAPI for years now.
- We only want modern tooling, so if the tool is OpenAPI v2.0 only (and is not in the progress of adding v3 support) maybe find a different list to add it to.
- We try talk about "Description Documents" instead of "Specs" for reasons.
- Send a pull request and make sure the build doesn't break!