在Java当中我们通过Swagger来搭建Restful Api,所提供的便捷不言而喻,因此在学习python的flask搭建python web的时候,我们第一下想到的就是搭建这样风格的Restful Api
在寻找了尝试了很多网上的方法之后,最终决定使用flask-restplus()flask-restplus.readthedocs.io/en/0.4.1/documenting.html
首先在项目的虚拟环境中导入该包
pip install flask-restplus
之后我们可以用注解的形式来修饰class或者方法
具体代码如下
from flask_restplus import Api, Resource
from flask import Flask
app = Flask(__name__)
api = Api(app, version='1.0', title='Sample title', description='this is the sample Api')
@api.route(/apps/<id>)
@api.doc(params={'id':'An ID'})
class Apps(Resource):
def get(self,id):
return {}
此时运行项目并且进行访问我们就可以看到