2.API文档（FastAPI）

FastAPI文档形式：交互式API文档、备用API文档

2.1交互式API文档

在浏览器中请求 http://127.0.0.1:8000/docs ，显示交互式API文档， 自动交互式 API 文档（由 Swagger UI 提供） ，如图：

 

此时可以单击某个具体的API，然后单击Try it out，然后填写参数，并单击Execute按钮来执行。

2.2备用API文档

在浏览器中请求 http://127.0.0.1:8000/redoc ，显示备用API文档， 备用的自动交互式文档（由 ReDoc 提供） ，如图：

 

通过ReDoc可以帮助我们生成接口文档

2.3FastAPI接口文档注释

• title 标题

• description 描述

• summary 注释

• tags 标签

示例：

from fastapi import FastAPI
app = FastAPI(title='第一个Fast API应用程序', description='整体描述')
@app.get(path='/', summary='接口注释', description='接口描述', tags=['Root'])
async def read_root():    
    return {"Hello": "World"}

API文档

 

也可以不使用summary进行接口注释，用多行注释取而代之，效果如下：

示例：

from fastapi import FastAPI
app = FastAPI(title='第一个Fast API应用程序', description='整体描述')
@app.get(path='/items/{item_id}', summary='接口注释', tags=['Items'])
async def read_item(item_id: int, q: str = None):    
    '''    
    项目    
    - param item_id: 项目ID    
    - param q: 查询参数    
    - return: 以给定项目ID和参数为数据的对象，字段为item_id,q    
    '''    
    return {"item_id": item_id, "q": q}

API文档