All geek questions in one place

Microservices API Centralized Documentation

My team and I are currently creating several services in parallel. We have the opportunity to build all services from scratch. I would like to automatically display all API endpoints from all services on one page / site. This would be useful because (by the way):

  • I don’t have to go to several documentation sites to find out which available endpoints are in my entire “system”.

  • This will be a good first step to determine if you need to split, merge, or simply reorganize any of the services.

Some of our services are located in Django, and this site module and everything related to Netflix , but could not find a solution to my problem. Centralized documentation may not have much to do with 600+ services on Netflix, but it's hard to believe.

Can anyone suggest a tool or method to have integrated API documentation for all services in a microservice architecture?

My ideal scenario of what happens when a service changes:

  • I click on the link to see a list of endpoints on my system.
  • The team assistant updates the service as well as the documentation.
  • I am updating the page in which I am now, and I see this change made from step number 2.
+6
source share
3 answers

With my exp, you have several ways.

  • http://readme.io/
  • Create a wiki with JIRA, Redmine.
  • On Github, create a repo for exclusive documents.
  • Google Docs
+1
source

I don’t know about any existing tool, but just think about where to do it.

From the OP description, they are already building a microservice architecture using the Netflix stack. There must be a repository to configure the name (or URL) for each of the services, and the "config server" or "service registry" will read from this. For me, this is the perfect place to put links to each of the microservice documentation under your own records. Thus, you get the opportunity to maintain documentation and code in one place, and you can also collect runtime information, such as instance / connection counter, if you connect to the configuration / registry server.

0
source

In a similar situation, I want to accept https://readthedocs.org/ with GIT support.

0
source

Source: https://habr.com/ru/post/988525/

More articles:


All Articles