restweb-servicesdocumentationspecifications

Good tools for writing rest api technical especification


What are good tools for writing rest API technical especification and documentation? I need to specify URLs, routes, endpoints.

Another approach would be to automatically generate an API documentation reverse engineering its code. It's a C# webservice.


Solution

  • I see three main languages to do that. You can then generate documentations from this using additional tools around these languages.

    Another tool called Slate is documentation-oriented. It allows to generate beautiful documentation with sample calls in different programming languages.

    You can notice that the tool Restlet Studio allows you to define the structure of your RESTful service online and get then corresponding Swagger or RAML structure. You can even generate documentations (or client kits, server skeletons) based on these formats.

    Hope it answers your question! Thierry