We need to define our requirements for a REST API. What are tools which aid in creating a document which will fully describe the webservice so it can be created by another entity?
I am a RESTful web developer (real, “HATEOAS”, Level 3 REST) but I have never come across a tool to help me define a service. For general diagramming purposes however, I do like OmniGraffle.
To be honest, I think a text editor, a knowledge of the domain and of the recipient’s level of vocabulary and understanding, are all you really need.
Are you wanting to specify every resource and how it relates to every other resource? How low down into the details are you trying to go?
2