FastAPI Instrumentation

1
from fastapi import FastAPI
2
3
...
4
5
FastAPI(
6
    openapi_url="/openapi.json",  # <-- 这是访问 OpenAPI 规范所需的文件和 URL，`docs_url` 和 `redoc_url` 是在 UI 中显示文件的便捷包装器！
7
    docs_url="/docs",             # <-- 这是访问 Swagger UI 的 URL，它将指向您的 OpenAPI 规范
8
    redoc_url="/redoc"            # <-- 这是访问 ReDoc UI 的 URL，它将指向您的 OpenAPI 规范
9
)

1
from fastapi import FastAPI
2
3
...
4
5
app = FastAPI(servers=[{"url": "http://prod.test.com", "description": "Production server"}])
6
# 这在您的 OpenAPI 规范中创建了以下服务器对象：
7
# "servers":[{"url":"http://prod.test.com","description":"Production server"}],

1
@router.post(
2
    "/your/post/endpoint",
3
    response_model=YourResponseModel,            #  <-- 在 FastAPI 中，指定响应模型很重要，这样它就会出现在 OpenAPI 规范中
4
    summary="Get some response for your req",    #  <-- 如果您想为端点添加描述，可以在这里添加
5
    openapi_extra={                              #  <-- 最后，您可以在这里添加 Fern 扩展，这些扩展将产生类似于 python 中 `client.endpoints.create(...)` 的 SDK 代码
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
        }