Django接口文档的生成

Django接口文档两种生成方法

一.django-rest_framework风格接口文档：

1.安装依赖
pip install rest_framework #如果之前有了就跳过这步
pip install coreapi

2.setting.py设置

INSTALLED_APPS = [.....'rest_framework',
]
.....
REST_FRAMEWORK = {'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
}

3.项目整体 url.py 文件设置

from django.conf.urls import url
from rest_framework.documentation import include_docs_urls
urlpatterns = [.....url(r'docs/', include_docs_urls(title='接口文档'))
]

这里稍微提及一下接口文档中参数的解释主要取决于 filter.py或serializer.py 文件中 class Meta 中的字段，可以设置字段的 help_text 来为参数添加中文注释。我这里没深究，仅仅作为一个总结，filter.py中 fields中的字段能够起作用，而类中定义的 goods_id2 也能显示，但请求无效，所以尽量二者同名，便面接口生成多余参数。

class GoodsDetailFilter(filters.FilterSet):"""商品的过滤类"""goods_id2 = filters.NumberFilter(field_name="goods_id", lookup_expr='contains', help_text='商品id')  # 自定义字段class Meta:model = Goodsfields = ['name','goods_id']

二.swagger接口文档生成

1.安装swagger
pip install django-rest-swagger

2.配置项目的settings文件

INSTALLED_APPS = [.....'rest_framework_swagger',
]

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

class GoodsListSearch(CacheResponseMixin, mixins.ListModelMixin, mixins.RetrieveModelMixin, viewsets.GenericViewSet):"""list:显示商品列表，分页、过滤、搜索、排序retrieve:显示商品详情"""queryset = GoodsCategory.objects.all() .........

4.项目整体 url.py 文件设置

from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer
schema_view = get_schema_view(title='Users API', renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer])urlpatterns = [# swagger接口文档路由url(r'^docs/', schema_view, name="docs"),
]

两种方法访问接口文档路径：
http://127.0.0.1:8000/docs/

Django接口文档的生成相关推荐

写接口文档及生成mock数据
写接口文档及生成mock数据在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
php怎么根据接口文档实现功能,CodeIgniter+swagger实现 PHP API接口文档自动生成功能...
一.安装swagger 1.首先需要有composer,没有的自行百度安装 2.下载swagger,打开网站https://packagist.org/packages/zircote/swagger ...
IDEA：Idea 集成 EasyYApi 插件实现接口文档的生成与更新
我是 ABin-阿斌:写一生代码,创一世佳话,筑一览芳华.如果小伙伴们觉得不错就一键三连吧~ 声明:文章原文来源处: https://blog.csdn.net/weixin_40863968/art ...
接口文档如何编写，接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍接口:API API(Applic ...
Django DRF 自动生成接口文档
文章目录 1. 引子 2. 自动生成接口文档 3. 文档描述说明的定义位置 1. 引子前端请求的url由谁来写 url 主要有后台来写,写完给前端: 如果后台查询数据,需要借助查询条件才能查询前端需 ...
Django API接口文档使用说明
Django API接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 1. 安装依赖 RES ...
RESTful之自动生成接口文档
REST framework可以自动帮助我们生成接口文档.[必须是继承自rest_framework才会自动生成文档] 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的 ...
idea swagger生成接口文档_spring boot集成Swagger-UI接口文档
本文介绍如何用spring boot集成Swagger-UI,实现项目在线接口文档一.Swagger-UI简介 Swagger是一个Restful风格接口的文档在线自动生成和测试的框架官网对Swa ...
【若依(ruoyi)】swagger 生成接口文档
前言若依(ruoyi): v4.3 若依自带了 swagger 的接口. 将若依启动后,访问 http://localhost/swagger-ui.html (或者使用菜单系统工具 -> 系 ...

Django接口文档的生成

Django接口文档两种生成方法

Django接口文档的生成相关推荐

最新文章

热门文章