一个用于验证Django API请求和响应对象的Django应用程序。
项目描述
Validator是一个Django应用程序,用于验证Django API的请求和响应对象。
快速开始
在您的INSTALLED_APPS设置中添加“validator”,如下所示,在您的应用之前
INSTALLED_APPS = [ ... 'validator', ]
将“validator.middleware.Validator”添加到您的MIDDLEWARE设置中,如下所示
MIDDLEWARE = [ ... 'validator.middleware.Validator', 'django.middleware.common.CommonMiddleware', ... ]
在settings.py中添加SCHEMA变量,该变量给出了schema.json文件的位置。
SCHEMA = ‘ext_app/schema.json’
在settings.py中添加DOCUMENTATION变量,该变量给出了要生成的DOC.md文件的位置。
DOCUMENTATION = ‘ext_app/DOC.md’
要从schema.json生成API文档,请运行
python3 manage.py gen_docs