首页 > 其他分享 >django-rest-swagger

django-rest-swagger

时间:2023-01-19 15:00:38浏览次数:61  
标签:rest django framework api 文档 swagger

在日常工作中,程序员最苦恼的事情大概就是写文档了吧,虽然文档能够利于程序的传承,但是由于业务口径频繁变更,导致维护文档也变成了一件费时又费力的事情。因此,如果能够自动生成API文档那么对于程序员来说就可以省事很多,刚好一些流行的框架已经原生集成了自动生成api功能,比如django,接下来就和大家分享一下如何利用Django框架开发api

这里介绍下 django-rest-swagger,使用方法如下:
1、先安装:

pip install django-rest-swagger

2、加入到 INSTALLED_APPS

    INSTALLED_APPS = (         ...         'rest_framework_swagger',     )

3、修改项目 urls.py,类似下面这样:

from django.conf.urls import url from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API 接口文档') urlpatterns = [     url(r'^docs$', schema_view) ]

本例中的效果如下所示:

rest_framework_swagger

rest_framework_swagger

交互

交互

功能和原生的大同小异,多了 curl 访问接口的方式,每个人喜欢的风格不一样,网上还有很多生成 api 文档的轮子,大家可以选一款自己喜欢的直接用就好。

以上就是“如何利用Django框架开发api(使用django自动生成api文档)”的详细内容,想要了解更多django框架内容欢迎持续关注编程学习

标签:rest,django,framework,api,文档,swagger
From: https://www.cnblogs.com/beichengshiqiao/p/17061495.html

相关文章

  • 关于#springCloud集成swagger#的问题
    提问:关于#springCloud集成swagger#的问题,如何解决?springCloud整合swagger时Postman请求接口没问题,但用swagger访问时需要认证客户端但后端日志显示已经请求成功。解答:在Sp......
  • Swagger UI接入配置
     SwaggerUI接入配置这里的接入我们依赖于DRF官方推荐的一个第三方包: drf-yasg,下面的接入步骤其实都是按照这个第三方库的文档进行配置,这里只是个最最入门的使用,对于......
  • Django[三]配置文件settings.py
    一.配置文件详细说明参考:http://c.biancheng.net/view/7475.html二、根据自己的需要修改配置文件1.修改DATABASES连接mysqlDATABASES={'default':{'E......
  • django FilteredRelation 的用法
    有两大用处FilteredRelation类允许为查询集增加一个ON从句可以在多个join中语句直接引用变量fromdjango.db.modelsimportFilteredRelation,Qresult_1=Restaur......
  • django的 prefetch_related 只能 all() 可以用 filter ?
    直接说答案<=Django1.6只能在使用代码过滤somethings=Foo.objects.filter(author="author").prefetch_related("bar_set")forainsomethings:somebars=[p......
  • Django一个“高质量”小白的学习之路(给自己看)
     第一天day1:人类的思维倾向于直白、视觉和线性,还有好奇心,这是祖先遗传下来的思维习惯。如果论结果,显然我是一个计算机学习的失败者。因为我作为一个已经刚到不惑之年......
  • Swagger快速使用
    Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。pom<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2-......
  • Springboot整合swagger3
    引入依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</ve......
  • RestTemplate去掉https验证
    /*@BeanpublicRestTemplaterestTemplate()throwsKeyStoreException,NoSuchAlgorithmException,KeyManagementException{TrustStrategyacceptingTrustSt......
  • django model 创建表参数字段
    首先,关于model,是数据库与python代码里的一个映射关系,每一个model是django.db.models.Model的一个子类。model里每一个属性值(即字段)代表数据库的字段,通过定义mode......