FastAPI Instrumentation

1
from fastapi import FastAPI
2
3
...
4
5
FastAPI(
6
    openapi_url="/openapi.json",  # <-- this is the file and URL needed to access the OpenAPI Specification, `docs_url` and `redoc_url` are convenient wrappers that display the file in a UI!
7
    docs_url="/docs",             # <-- this is the URL to access the Swagger UI, which will point to your OpenAPI Specification
8
    redoc_url="/redoc"            # <-- this is the URL to access the ReDoc UI, which will point to your OpenAPI Specification
9
)

1
from fastapi import FastAPI
2
3
...
4
5
app = FastAPI(servers=[{"url": "http://prod.test.com", "description": "Production server"}])
6
# This creates the following server object in your OpenAPI Specification:
7
# "servers":[{"url":"http://prod.test.com","description":"Production server"}],

1
@router.post(
2
    "/your/post/endpoint",
3
    response_model=YourResponseModel,            #  <-- with FastAPI, it is important to specify your response model so that it comes through to the OpenAPI Specification
4
    summary="Get some response for your req",    #  <-- if you'd like to add a description to your endpoint, you can do so here
5
    openapi_extra={                              #  <-- finally, you can add in your Fern extensions here, these extensions will produce SDK code that looks something like: `client.endpoints.create(...)` in python
6
        "x-fern-sdk-method-name": "create",
7
        "x-fern-sdk-group-name": "endpoints",
8
        "x-fern-availability": "beta",
9
    },
10
)
11
async def your_post_endpoint(
12
    payload: YourRequestModel,
13
) -> YourResponseModel:

1
from pydantic import BaseModel
2
3
class MyObject(BaseModel):
4
    id: str
5
6
    class Config:
7
        schema_extra = {
8
            "example": {
9
                "id": "a-cool-uuid",
10
            }
11
        }