0x00 背景介紹
因為工作上的需要,最近開始研究Python中實現Restful API的框架和工具包。之前粗略學習過Flask,由於它比較輕量級,感覺用它來實現Restful API再適合不過了。於是,將精力重點放在了Flask及其配套工具包上,最先學習的是Flask-Restful,不過在學習的過程中感覺,如果能有一個像swagger那樣的對Restful API自動創建文檔的工具包該多好,於是就搜索這方面的Python包,當然第一就想到的是Python方面有沒有swagger的包,別說還真有,不過粗略看了一下沒明白其原理,貌似全靠配置來實現,於是就沒再深入學習了。偶爾的一個機會遇到了Flask-RESTPlus,不得不說,這就是我正要找的工具,它既包含Flask-Restful包的功能,又自動包括了swagger的文檔化功能(其實就是封裝了swagger),簡直是一個短小精悍的利器。
於是,花了一天時間看了一遍Flask-RESTPlus的官方文檔,越看越覺得寫的很好,而且越發肯定它就是我要用的東西,於是決定將官方文檔動手實踐一遍,通過實踐來解決閱讀過程中的疑問,並順便將官方文檔根據自己的理解翻譯整理一下。
0x01 系列譯文目錄
Flask-RESTPlus是對Flask的擴展,它增加了對快速開發REST API的支持。Flask-RESTPlus鼓勵以最小的設置來實現功能的開發。如果你熟悉Flask,那么會很容易就能上手Flask-RESTPlus。Flask-RESTPlus中提供了大量的裝飾器和工具來描述你的API,並以文檔化的形式將這些接口展現出來(通過Swagger來實現)。
本系列譯文編寫之際,Flask-RESTPlus的最新版本為v0.11.0,該系列將包含以下內容:
0x02 開發環境
- 系統:Windows10_x64 專業版
- Python:v3.6.1_x64
- Python IDE:PyCharm 2017.1.5