路径操作装饰器方法的参数
1. 定义带有参数的POST请求路由
@app.post('/items',tags=['这是items测试接口'],summary='这是items测试的summary',description='这是items测试的description',response_description='这是items测试的response_description')
def test():return {'items': 'items数据'}
@app.post('/items')
定义了一个POST请求路由,路径为/items
。tags
用于在API文档中对路由进行分类。summary
提供了简短的描述。description
提供了详细的描述。response_description
提供了响应的描述。
2. 定义弃用的POST请求路由
@app.post('/deprecated', deprecated=True)
def deprecated_test():return {'deprecated': '看看deprecated的展示!'}
deprecated=True
标记该接口为弃用状态。默认不写是Flase
3. 测试接口
通过这些步骤,你可以创建和运行一个带有参数的 FastAPI 应用,并在 API 文档中查看详细的描述信息。
4.完整代码如下:
from fastapi import FastAPI
import uvicorn
app = FastAPI()@app.post('/items',tags=['这是items测试接口'],summary='这是items测试的summary',description='这是items测试的description',response_description='这是items测试的response_description')
def test():return {'items': 'items数据'}@app.post('/deprecated', deprecated=True)
def deprecated_test():return {'deprecated': '看看deprecated的展示!'}
"""
当然,还有其他很多参数,后面具体再说!
"""
if __name__ == '__main__':uvicorn.run('main:app', port=8080, reload=True)