FastAPI后台开发基础（20）：设置 FastAPI 元数据

原创

密码学人CipherHUB

发布于 2024-11-20 12:54:58

3570

设置描述信息

from __future__ import annotations

import uuid

import uvicorn
from fastapi import FastAPI

description = """
这是我的FastAPI描述信息 🚀😄

# 一级标题

这是一级标题下的 **内容**.

## 这是二级标题

description 参数中可以使用 markdown 语法，比如设置列表:

* **Create users** (_not implemented_).
* **Read users** (_not implemented_).
"""

app = FastAPI(
    title = "FastAPI Metadata 元数据设置",
    description = description,
    summary = "总结信息",
    version = "0.0.1",
    terms_of_service = "https://cloud.tencent.com/developer/user/1371154",
    contact = {
        "name": "bowenerchen",
        "url": "https://cloud.tencent.com/developer/user/1371154",
        # "email": "bowenerchen@demotest.com",
    },
    license_info = {
        "name": "Apache 2.0",
        # "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
        "identifier": "MIT"
    },
)


@app.get("/items/")
async def read_items():
    return [{"unique_id": uuid.uuid4().hex}]


if __name__ == '__main__':
    uvicorn.run(app, host = '127.0.0.1', port = 18081)

设置接口文档与文档 URL

from __future__ import annotations

import uuid

import uvicorn
from fastapi import FastAPI

path_operation_tags = [
    {
        "name": "标签 1",
        "description": "Manage items. So _fancy_ they have their own docs.",
        "externalDocs": {
            "description": "Items external docs",
            "url": "https://spdx.org/licenses/MIT.html",
        },
    },
    {
        "name": "标签 2",
        "description": "Manage users. So _fancy_ they have their own docs.",
        "externalDocs": {
            "description": "Users external docs",
            "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
        },
    },
]
app = FastAPI(openapi_tags = path_operation_tags,
              openapi_url = '/my_custom_openapi_json',
              docs_url = '/my_custom_swagger_ui_html',
              redoc_url = '/my_custom_redoc_html')


@app.get("/items_1/", tags = ['标签 1'])
async def read_items_1():
    return [{"unique_id": uuid.uuid4().hex}]


@app.get("/items_2/", tags = ['标签 2'])
async def read_items_2():
    return [{"unique_id": uuid.uuid4().hex}]


if __name__ == '__main__':
    uvicorn.run(app, host = '127.0.0.1', port = 18081)