Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Search - "apiary"
-
!Rant
TLDR: What's your favorite REST API Documentation tool?
I'm about to start developing a really large REST API. I have never really had need to document my previous API's since they were small, self explanatory and had only me using them. Aside from this one being too large for me to keep track of there is also a remote team that will need to integrate with it.
Basically I need write exceptional documentation while using as little time as possible. I love postman and am planning to use it for documentation since I currently use it to test during development anyway but I have seen some really neat looking tools like swagger and apiary so I figured I would check for some other suggestions.
What is your current / preferred REST API documentation method?13 -
<rant> Why is Apiary's editor so weak? It has no support for navigating from request to its code, it hides inheritance (so in the end you end up navigating source code via ctrl+f which is very cumbersome) and is buggy as hell. It randomly scrolls around, after awhile is laggy, syntax highlighting often breaks on a blank line with few spaces and so on... I wish so hard it would have had a plugin for IntelliJ IDEA with proper navigation and request preview. The web "editor" is just so clunky and generally bad :(.</rant>