FastAPI Microservice (Py) (0.1.0)

Download OpenAPI specification:Download

This is a microservice project template for Python. It is intended to demonstrate a production-grade microservice in Python with a maintainable structure, optimised containerisation, build automation and a CI/CD pipeline. The project is using FastAPI which is a modern, fast (high-performance), web framework for building APIs with standard Python type hints.

Health

This endpoint is used to check the health of the service.

Responses

Response samples

Content type
application/json
{
  • "status": "UP",
  • "message": "string"
}

Ready

This endpoint is used to check if the service is ready to receive requests.

Responses

Response samples

Content type
application/json
null

Metrics

Endpoint that serves Prometheus metrics.

Responses

Response samples

Content type
application/json
null