标签：配置 description Fastapi app 常见 接口 文档 FastAPI 描述

1.路径操做配置

@app.post(
  "/path_operation_configuration",
  response_model=xxx,
  # 接口描述，一般放在`app.include_router`里面，做一个模块划分
  # 如果有有多个，则在文档中国该接口会分别展示多条
  tags=['path', 'Operation', 'Configuration'],
  summary="This is summary",  # 接口文档中接口路径后面的描述，默认是该接口对应的方法名，首字母大写
  description="This is description",  # 接口文档中的描述
  response_description="This is response description",  # 响应体的描述
  deprecated=True,  # 表示接口已经废弃，在文档中会展示灰色，且被中划线划掉，但是还可以正常调用，只做展示而已
  status_code=status.HTTP_200_OK
), 

1.Fastapi常见的配置

app = FastAPI(
    title="FastAPI Tutorial",   # 文档标题
    description="FastAPI接口文档，项目代码：https://github.com/xxxx",  # 文档描述
    version='1.0.0',  # 版本描述
    docs_url='/docs',  # 文档路径
    redoc_url='readme_docs'  # redoc文档路径
)

标签：配置,description,Fastapi,app,常见,接口,文档,FastAPI,描述
来源： https://www.cnblogs.com/puffer/p/16415533.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。