Forum Discussion

Danielgu's avatar
Occasional Visitor
4 years ago

Internal API endpoints usage documentation in Microservices

I am doing some research about API documentation for microservice which I would like to implementing in our product.
For now I saw tools like Swagger which are automating API documentation but only for endpoints (url, objects, params, responses..), but I couldn't find features to document the usage of these APIs, for example which other internal components are using these endpoints (UI/other microservices).
I thought this could be good information to document, for purposes like editing existing APIs and be aware of other components which relays on the changed API.
Maybe I am mistaken and this feature is unnecessary and there are other solution and best practices to avoid breaking other services/UI which are using an API which is going to be edited (params/responses). 
​Is there feature to achieve this?

Thanks in advance!
No RepliesBe the first to reply