Skip to content

traefik-workshops/planet-api

Repository files navigation

Planet API

Example API based on FastAPI.

Requirements

Run the container

docker run --name api-example -p 8080:8080 testthedocs/planet-api

Open your browser on http://localhost:8080 to see the welcome message.

OpenAPI docs

Assuming that the container is running, visit one of the URLs below to browse the docs.

Swagger UI

http://localhost:8080/docs

Swagger UI

Redoc

http://localhost:8080/redoc

Redoc

Kubernetes

Use kubectl to deploy the API to a Kubernetes cluster.

kubectl apply -f api.yaml

Postman

You can use Postman for sending API requests.

Postman

About

Basic example API based on FastAPI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published