快速開始

本指南假設您對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 風格的畫面。