Skip to main content

Deploying docs from FastAPI

FastAPI is a Python framework that allows you to create APIs, and automatically generates their documentation, based on the OpenAPI specification.

Deploying docs from your local machine​

The following assumes your local machine is configured with Python and FastAPI, and that your main file is named main.py.

  1. Create and name your first API documentation.

  2. Install the Bump.sh CLI with npm as below, or use alternative options, with

npm install -g bump-cli
  1. Launch your local server with 
uvicorn main:app --reload

Note: You might need, depending on how you usually run your Python commands, to prepend them with python3 -m.

  1. Deploy your doc to Bump.sh with
bump deploy http://127.0.0.1:8000/openapi.json --doc my-documentation

That's it! Enjoy the comfort of Bump.sh to browse through your API doc, and customize it to your needs.