Which tool do you use to document APIs?
Exploring options to document APIs that can be exposed to third parties for their use. Which tool do you recommend?
Evaluation parameters are -
- Ease of use
- Good design
- Good pricing
- Ability to have custom domains/sub-domains
Maybe Swagger could fit your needs.
+1 to swagger for REST APIs . It's free, it's open source and it can be packaged into your project. Make sure that it is integrating into your codebase strictly. There are tons of solution for specific frameworks you are based on.
Maintaining API documentation and codebase separately could cause headache.
+1 for swagger. We use .NET and Swagger for our api documentation.
Swagger is by far the best UI for Restful services
Looks nice.
We use Slate (https://github.com/lord/slate) with a bit of custom css: https://docs.base.run/
I would recommend Codegiant.io to created good documents. Example - https://docs.codegiant.io/codegiant/api
PS - I am the founder of Codegiant (:wink)
Thank you :)
no one mentioned these but I think they're totes worth it :
RAML, it's much more concise and abstracted at a higher level than swagger.
I think https://dimerapp.com/ nails all of that.
Looks very clean and super-simple pricing.
Thanks for introducing this :)
html...
Our engineers constantly create documentation for customers and, from our experience, the best and most maintainable were those not making use of any service, probably just using node or a simple static site generator.
https://swagger.io/
We use swagger combined with https://github.com/sourcey/spectacle hosted on s3 as a static site.
Currently using this http://apidocjs.com
However swagger looks good too
This seems decent. But, the design does not impress.
Hi, take a look at https://vuepress.vuejs.org/ . Maybe it works for your purpose.
It is not specific to APIs but is a great tool.
This deviates from my requirement right now. But, overall a good site.