Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document Microservice API/Endpoints

See original GitHub issue

In Bank of Anthos, there is a README.md file for each microservice detailing the endpoints, environment variables, and other info about the respective microservice (e.g., see README.md for userservice).

We want to do something similar with this sample app (microservice-demo).

CC: @askmeegs

Issue Analytics

State:
Created 2 years ago
Comments:6 (2 by maintainers)

Top GitHub Comments

1reaction

polaroi8dcommented, Oct 26, 2021

It would be super great. If I would like to try the microservice-demo with simple docker-compose it’ll be easier with this information.

0reactions

donmccaslandcommented, Nov 30, 2022

Nim, if we’re not going to work on this before EOY, can we go ahead and close?

Top Results From Across the Web

Maintaining and documenting API endpoints of many ...

Let's say we have inherited 20 microservices that are owned by different teams and there is no clear documentation about which application uses ......

API Documentation Guide - How to Cook Microservices

API Documentation Requirements docs are used as expectation against endpoints. So for example if you update endpoint's template and forget to update ......

OpenAPI Microservices Guide | Open API Spec Format

You can use OpenAPI to create a style guide to suggest how endpoints, requests, responses, and fields should be implemented. And you can...

How to strategically approach documenting microservices

Building microservices requires planning for every step of the process, from defining the APIs and endpoints to production readiness, but one of the...

How To Configure API Gateway in Microservices Architecture

API gateway acts as a security layer between the front end and the backend microservices to ensure that the sensitive API endpoints are...