Ask HN: What tools do you use for Developer Portals / API Docs?
What tools have you found useful to quickly build developer portals, specifically API documentation? We have looked at SwaggerHub and Gelato. Any feedback on either or other tools you have found to be valuable?
9 comments
[ 5.0 ms ] story [ 31.9 ms ] threadHave a look at https://apiblueprint.org/tools.html which covers mocking APIs, converting to https://www.getpostman.com/, validation inside IDEs and generating HTML for self-hosting.
http://documentation.js.org/ is relatively new and seems to target nodejs primarily.
Essentially you write tests that then generate your documentation, so you get a load of happy path integration tests and up to date documentation. It's a great way to ensure the documentation and code does what it says.
Our happy path integration tests produce markdown files detailing the route,payload, expected status codes etc and then we manually add these snippets to a menu markdown file. When we work on a feature branch with public API changes then our CI system detects documentation changes and when merged pushes to Jekyll.
[1] https://github.com/swagger-api/swagger-codegen