Django+swagger接口文档生成


swagger 主要用于接口管理,以往都是word或Excel管理API文档,当API发生变动时,经常会出现信息不同步,导致API不一致的问题。

swagger管理接口后,可以实时更新API,也可以同步更新注释信息等。方便API的信息同步。 

 

1.安装swagger

pip install django-rest-swagger

 

2.配置项目的settings文件

 

3.在views中添加注释内容,用于描述接口的功能等

 

4. 在urlsz中添加路径。

 

5.访问路径:http://127.0.0.1:8000/docs/  见到下图所示界面,表示配置成功。

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM