Python web api的实践

    最近接到产品需求,年后新办公区Led大屏显示公司业务数据，采用一贯的前后端分离开发,我前面同事负责数据入库更新,我提供后端api接口给前端，前端根据设计稿设计样式渲染数据到页面。

    为保证服务响应时间，后端采用redis+mysql作为数据库，查询优先查询redis，redis查不到查询mysql并写回redis。

    磨刀不误砍柴工，接到需求之后，先不要着急写代码，整体上把握下需求（接口怎么定义/接口文档怎么写/多大工作量/）。前后端交互，前端负责发起http请求，后端服务器接收到请求，拿到请求参数，返回接口约定的数据结构给前端。工作量最大的地方在于每个接口的入参和出参，一是服务端代码的编写，二是接口文档的编写，文档是前后端沟通的中介，所以有没有可能，定义一套api的规则，既能实现接口文档的自动生成，又可以减少服务端的代码量，这样，我只需要关注接口的规则，添加减少接口的配置就可以。

接口规范及说明

返回公共字段说明各脚本功能

API 配置 config.py

代码示例

接口服务程序 app.py

自动生成接口文档 api_doc.py