Skip to content

ThoughtWorks-DPS/hello-restful

Repository files navigation

Thoughtworks Logo
DPS Title

Lightweight API providing request and response endpoints

hello-restful


hello-restful is a small, fastapi service designed to be deployed on kubernetes and provide common http request/response endpoints and demonstrate using an openapi framework for automated api documentation.

Access at https://twdps.io/v1/hello. OAS documentation here. pending

To run locally on docker:

docker run -it -d -p 8000:8000 ghcr.io/thoughtworks-dps/hello-restful 

Access on http://localhost:8000/v1/hello

local developement

run locally with uvicorn

$ uvicorn api.main:api --reload