docs.intersystems.com
Home  /  Application Development: Additional Options  /  Creating REST Services and Using REST in Productions  /  Documenting REST APIs with API Management


Creating REST Services and Using REST in Productions
Documenting REST APIs with API Management
[Back]  [Next] 
InterSystems: The power behind what matters   
Search:  


When you provide REST interfaces to developers you should provide documentation so that they know how to call the interfaces. You can use the Open API Spec to document REST interfaces and a tool, such as Swagger to edit and format the documentation. InterSystems is developing a feature to support this documentation. This release contains a feature in API Management that generates the document framework for your REST APIs. You still need to edit the generated documentation to add comments and additional information, such as content of arguments and HTTP return values.
To generate the documentation for the CoffeeMakerApp REST sample, enter the following REST call:
You can paste the output from this call into the swagger editior. It converts the JSON to YAML (Yet Another Markup Language) and displays the doc. You can use the swagger editor to add more information to the documentation. The swagger editor displays the documentation as shown in the following: