I'm looking for a tool like gitbook.com to publish API docs. It has to be free or super cheap (<5$/mo) and support custom domain (docs.mysite.com).
Any tips?
I've tried Gitbook but found the editing is pretty clunky (e.g. can't reorder params in an API description, copy/pasting h
We use https://swagger.io/ Swagger. It is very powerful but hard to get started on it
Can you show me a sample documentation built with swagger?
https://petstore.swagger.io/
Hi guys, I'm very new to API documentation and have been browsing for a few free/freemium ones. For the record I'm a product manager and might not understand all the features mentioned on tools like redocly, postman, gitbook, etc.
The requirement for our API documents are as follows:
Any suggestion on which tool works the best for this? Thanks.
I'm building something that might help. https://mylodocs.com. It creates a documentation site from markdown files stored in Github. No editing capabilities yet, but there are plenty of good markdown editors.
This looks perfect for my new project, signing up now, thanks!
Not specific to API docs, but GitBook is pretty slick for publishing docs kept in version control.
Design looks great but it's pretty clunky when editing tbh.
I'm looking to try out https://github.com/lord/slate
It does require a server though. But you can easily set it up for free with a cheap machine on Google Cloud.
I'd be interested to hear other options as well
We run on Slate and host it on Github: https://api.supervisor.reviewshake.com/#introduction. Very simple deploys.
Looks like exactly what i need. Can you tell me how your deployment process is like?
You can read about it here: https://github.com/lord/slate/wiki/Deploying-Slate
Doesn't need to be on a server, it builds a static site. Used it for a previous project. Host on Netlify for free easy hosting as well.
Thank you for clarifying !
What about You Need A Wiki?
Thanks, but doesn't look like it's suited for API docs. It looks more like a more generic solution for general documents sharing.
This comment was deleted 2 years ago.