Good examples/templates/best practices API documentation
Im creating the front end for a web service, and another company the back end. I need a good, simple and easily understandable way of making a document of API calls that we can collaborate on and edit together without confusing one another.
are there any开发者_Go百科 good specs/examples etc of project API documentation so this doesnt get in a huge mess with many re-writes?
My choice for documentation: Sphinx.
Others:
- epydoc
- pylit
But Sphinx is quite awesome.
For small APIs I´ve began to use Google Docs. Its collaboration features are awesome and you can see a list of all changes made on this document.
精彩评论