码迷,mamicode.com
首页 > 其他好文 > 详细

django 之swagger配置与生成接口文档

时间:2020-09-16 12:05:20      阅读:64      评论:0      收藏:0      [点我收藏+]

标签:openapi   生成   访问   地址   rmi   setting   code   配置到   path   

swagger好处不多说,直接上配置步骤

1、安装swagger

pip install django-rest-swagger

2、将swagger配置到setting.py文件中

技术图片

3、在主url.py中配置接口文档路径

技术图片

代码解析:

from rest_framework.schemas import get_schema_view  # 导入restframework的辅助函数get_schema_view


from rest_framework_swagger.renderers import  # 导入swagger的两个Render类SwaggerUIRenderer,OpenAPIRenderer

# 利用get_schema_view()方法,传入两个Render类得到一个schema view
schema_view = get_schema_view(title=API,renderer_classes=[SwaggerUIRenderer,OpenAPIRenderer])


urlpatterns = [

    path(docs/, schema_view, name="swagger接口文档")  # 配置接口文档的url
]

 

4、启动服务,在浏览器中输入 127.0.0.1:8000/docs访问接口文档

技术图片

搞事情,运行后发现报错了,没有未认证

5、解决步骤4中权限问题,加入身份认证

schema_view = get_schema_view(title=API, renderer_classes=[SwaggerUIRenderer, OpenAPIRenderer], permission_classes=())

再次启动服务,访问接口地址

技术图片

 

django 之swagger配置与生成接口文档

标签:openapi   生成   访问   地址   rmi   setting   code   配置到   path   

原文地址:https://www.cnblogs.com/mian-1122/p/13601909.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!