1
 Follower
7
 Likes

Exposed REST API Documentation for different HTTP status

Integration
New

Hi,


The problem

It's very common for a REST service to return more than one HTTP status code. Currently only the 200 status gets in the documentation.


This makes necessary  to document the API outside the platform, which brings typical problems like duplication, lack of synchronization, etc. 


We end up using the swagger generated automatically and import it in some API documentation platform so we can complete the documentation and send it to the consumers (internal or external). 


Therefore the documentation produced by the OutSystems platform ends up not being used.


Ideas how to solve it

A straightforward and simple approach to start could be Method dynamic properties  to add the documentation for each HTTP status code.

For example:


What do you think?


Thanks,

Renato


Created on 18 Sep 2018
Comments (1)

Changed the category to Integration


views
231
Followers
1