flask_restplus(1)- 未完成
快速开始
本指南假设您对Flask有一定的了解,并且您已经安装了Flask和Flask- restplus。如果没有,则按照安装部分中的步骤操作。
初始化
与其他所有扩展一样,您可以使用应用程序对象初始化它
from flask import Flask
from flask_restplus import Api
app = Flask(__name__)
api = Api(app)
或者懒惰的工厂模式
from flask import Flask
from flask_restplus import Api
api = Api()
app = Flask(__name__)
api.init_app(app)
简单的例子
一个最小的Flask-RESTPlus API像下面这样
from flask import Flask
from flask_restplus import Resource, Api
app = Flask(__name__)
api = Api(app)
@api.route('/hello')
class HelloWorld(Resource):
def get(self):
return {'hello': 'world'}
if __name__ == '__main__':
app.run(debug=True)
保存文件为api.py,然后运行它,这里(debug=True)使用了调试模式
注意⚠️
请不要在生成环境下使用调试模式。
现在打开一个命令行通过curl命令测试API接口。
$curl http://127.0.0.1:5000/hello
{
"hello": "world"
}
或者通过浏览器打开http://127.0.0.1:5000/同样可以看到一个Swagger UI 风格的画面。