Api-Shop

Api-Shop

一个快速易用的restful-api接口工具包,兼容:django / flask / bottle。

了解Api-shop →

简洁

用一个json数据或者@add_api装饰器配置接口

自动

自动校验参数、自动转换参数格式、自动生成文档和mock工具

省时

简化业务代码,外部和内部均可复用。一切只为少加班。

PyPI PyPI - Downloads

# 核心功能:

  1. 配置化 api 生成。
  2. 自动校验 request 提交的数据,并转换成指定格式,支持:int,float,list,dict,set,tuple,bool、自定义格式转换器和正则格式校验
  3. 自动生成 api 文档,并提供一个 web 页面可供查询和 mock 数据演示。
  4. 兼容 django , flask , bottle (如果不指定框架,默认按这个顺序识别框架)
  5. 自动生成接口骨架文件功能 beta(请谨慎开启)。
  6. 多国语言支持,也支持自定义语言包。
  7. 文档热重载。
  8. 默认值支持方法函数。
  9. 支持 url 中包含参数,例如 /api/user/<id>,并且在配置 methods 参数的时候设置它的规则。
  10. 支持多 url 绑定一个接口
  11. 支持指定参数的可选项,例如:[1,4,7],收到这个列表之外的参数就会触发 bad_request
  12. 可以在代码中直接调用 Api 业务代码:instance.api_run
  13. 支持在 Api 类中定义 response_docs 来制作返回值文档,并支持模型字段引入;以及模型部分字段引入类:ApiResponseModelFields
  14. 添加了全局单例类 SingleApiShop,用来替代 ApiShop,优点是支持用户封装后覆盖单例