标签:__ RESTX api Flask 47 API doc Swagger
前言
Swagger API 文档是自动生成的,可从您的 API 的根 URL 获取。@api.doc()您可以使用装饰器配置文档。
Swagger UI 文档
默认flask-restx提供 Swagger UI 文档,从 API 的根 URL 提供
from flask import Flask
from flask_restx import Api, Resource, fields
app = Flask(__name__)
api = Api(app, version='1.0', title='Sample API',
description='A sample API',
)
@api.route('/my-resource/<id>')
@api.doc(params={'id': 'An ID'})
class MyResource(Resource):
def get(self, id):
return {}
@api.response(403, 'Not Authorized')
def post(self, id):
api.abort(403)
if __name__ == '__main__':
app.run(debug=True)
运行上面的代码并访问 API 的根 URL ( http://localhost:5000 ),您可以查看自动生成的 Swagger UI 文档。
点开详情可以看到参数的描述
doc 文档路径
您可以使用参数控制 Swagger UI 路径doc(默认为 API 根目录):
from flask import Flask
from flask_restx import Api, Resource, fields
app = Flask(__name__)
api = Api(app,
version='1.0',
title='Sample API',
description='A sample API',
doc='/doc' # swagger 文档访问地址
)
那么Swagger UI访问地址是http://127.0.0.1:5000/doc
禁用文档
要完全禁用 Swagger UI,请设置doc=False:
from flask import Flask
from flask_restx import Api
app = Flask(__name__)
api = Api(app, doc=False)
标签:__,RESTX,api,Flask,47,API,doc,Swagger 来源: https://www.cnblogs.com/yoyoketang/p/16656220.html
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。