Hey Everyone, I am trying to setup an API documen...
# tribe
e
Hey Everyone, I am trying to setup an API documentation framework to share it with third party clients who would need to integrate with my API. I am looking for something like this: • https://stripe.com/docs/api -> Open API spec + multi programming language support. • https://stripe.com/docs -> For knowledgebase. I am looking for a software ( As I don’t want to get in to rabbit hole of developing and maintaining my own document websites when I can outsource ) that can support both API specification as well as knowledge base to share it with third parties. Does anyone have recommendations ?
h
l
+1 for Postman. It works quite well. Another option I have used in the past is https://swagger.io/ — if you comment your code in a specific format, Swagger will generate the docs for you which you can host easily.
e
Can we do knowledge base with Postman 🤔 ? Postman was my second option but didn’t evaluate it yet. I was considering to evaluate Spotlight as it supports both markdown-guides as well as api documentation: https://stoplight.io/api-documentation/
b
+1 for Swagger
r
Give ReDoc a shot. Have used Swagger and it is definitely handy!
➕ 1
👍 1
c
I have heard good things about ReadMe on Twitter. You might want to check it out as well.
➕ 1
e
Thank you so much all 🙏 , @calm-grass-85557 ReadMe looks really interesting. I will try it out and see this week.
👍 1