API接口数据自检

　　这个周末的娱乐，通用模块，让后端自检，严格客户端按照文档的要求来，妈妈再也不担心我加班了，对某些团队来说，可能根本用不着，本是想到就尝试一把而已。

 

　　哎，傻X的客户端程序员，时间都去推辞扯淡打扮啦，好好的文档还不足够，三项而已：接口地址、请求类型、必填及选填参数，老接口调错而错误不自知。

 

check-docking.

https://pypi.python.org/pypi/check-docking/

check-docking is a Python package that inspect request data from client for you.

 

介绍:

仅为总结前项目的经验, 在后续项目上, 接口文档的定义入库, 结合入库的数据生成配置文件.

根据生成的配置文件, 当客户端与服务端对接时, 让程序能够自动检查客户端的传入, 并将问题返回给客户端.

该模块的目的在于减少客户端开发过程中, 在琐屑问题上对服务端的干扰. 如请求类型错误, 多参, 少参, 重参, 数据类型错误, 是否必填项等等.

使用:

配置settings.py修改：

# check-docking配置项

IS_DATA_INSPECT = True # 仅 DEBUG 为 True 时有效

INSPECT_PROFILE = “project.check_config” # 检测依赖配置文件模块

INSTALLED_APPS 增加:

‘check_docking’,

‘check_docking.stored.django’,

下面两项非必须, 需要完成使用流程节点, 生成依赖的配置文件后启用其一.

MIDDLEWARE_CLASSES 增加:

‘check_docking.middleware.InspectMiddleware’

除了MiddleWare形式, 你也可以使用装饰器形式：

from check_docking.inspect import debug_request

＠debug_request

你还可以使用工具, 从源代码中搜集数据并入库, 具体可以参看project_demo/demo/demo.py中代码.

流程：

python manage.py syncdb

python manage.py runserver

http://127.0.0.0:8000/admin 录入数据.

python manage.py inspectprofile

 

转载于:https://www.cnblogs.com/kylinfish/p/4280827.html