Swagger UI¶

Interactive API documentation and testing.

Quick Start¶

Run your application with web_run():

from fasthttp import FastHTTP
from fasthttp.response import Response

app = FastHTTP()


@app.get("https://httpbin.org/get")
async def get_data(resp: Response) -> dict:
    return resp.json()


app.web_run()

After running, open in browser:

Swagger UI: http://127.0.0.1:8000/docs
OpenAPI Schema: http://127.0.0.1:8000/openapi.json

Available Endpoints¶

Endpoint	Description
`/docs`	Swagger UI interface
`/openapi.json`	OpenAPI schema in JSON
`/request`	Proxy for executing requests

Using Swagger UI¶

Viewing Documentation¶

All HTTP requests are automatically displayed with:

HTTP method (GET, POST, PUT, DELETE)
URL address
Description from docstring
Request parameters
Pydantic response models

Testing Requests¶

Find the desired endpoint in the list
Click to expand
Click "Execute" button
View response in Response section

Custom Host and Port¶

app.web_run(host="0.0.0.0", port=8080)

Custom Docs Base URL¶

app.web_run(base_url="/api")

Now the docs will be available at http://127.0.0.1:8000/api/docs.

With Tags¶

@app.get("https://api.example.com/data", tags=["users"])
async def get_data(resp: Response) -> dict:
    return resp.json()

Example¶

from fasthttp import FastHTTP
from fasthttp.response import Response
from pydantic import BaseModel


class User(BaseModel):
    id: int
    name: str
    email: str


app = FastHTTP()


@app.get("https://jsonplaceholder.typicode.com/users/1", response_model=User)
async def get_user(resp: Response) -> dict:
    return resp.json()


@app.post("https://jsonplaceholder.typicode.com/users")
async def create_user(resp: Response) -> dict:
    return resp.json()


# Run with Swagger UI
app.web_run()

Now open http://127.0.0.1:8000/docs or your prefixed docs URL such as http://127.0.0.1:8000/api/docs.