Django rest_swagger 接入
2019-10-04 本文已影响0人
虐心笔记
前言描述
目前开发一般都是齐纳后短分离,那么在用Django REST 快速开发接口的同时,如何简单高效的提供接口文档供前端人员进行联调?
本篇文章中大致讲解DRF swagger 接入的例子. 使接口文档变得美观可用, 可以进行请求以观察数据格式, 测试接口是否可用.
环境依赖
都是安装目前最新版本即可

一、setting
进入settings.py 文件, 确保INSTALLED_APPS中包含rest_framework、rest_framework_swagger。

然后对 rest_framework、rest_framework_swagger 进行详细配置如下:

二、配置路由
在urls.py 文件下新增标红的代码即可,这是最关键的部分,如果需要了解 swagger 的详细用法,建议点击查看源码或者去了解官方文档及使用

三、运行效果
在浏览器输入 http://127.0.0.1:8009/docs,查看效果


以上是简单讲述了自动加载接口,如果需要自定义接口参数、具体调试、实际使用可以自行去尝试,这里就不详细描述了,综上所述如果有疑问可以给我留言.