【Flask-RESTPlus系列】Flask-RESTPlus系列译文开篇

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,该系列将包含以下内容:

  1. 快速入门
  2. 响应编组
  3. 请求解析
  4. 错误处理
  5. 字段掩盖(Fields masks)
  6. Swagger文档化
  7. Postman测试
  8. 扩展项目
  9. 完整示例

0x02 开发环境

  • 系统:Windows10_x64 专业版
  • Python:v3.6.1_x64
  • Python IDE:PyCharm 2017.1.5

0x03 参考链接

posted @ 2018-06-10 10:07  HackHan  阅读(2632)  评论(0编辑  收藏  举报