在日常工作中,程序员最苦恼的事情大概就是写文档了吧,虽然文档能够利于程序的传承,但是由于业务口径频繁变更,导致维护文档也变成了一件费时又费力的事情。因此,如果能够自动生成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