【Django-DRF框架】生成各种API接口文档

在人生的道路上,不管是潇洒走一回,或者是千山独行,皆须是自己想走的路,虽然,有的人并不是很快就能找到自己的方向和道路,不过,只要坚持到底,我相信,就一定可以找到自己的路,只要找到路,就不必怕路途遥远了。

导读:本篇文章讲解 【Django-DRF框架】生成各种API接口文档,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

方式一:

1、安装

pipenv install coreapi
pipenv install Pygments
pipenv install Markdown

2、配置

REST_FRAMEWORK = {
   ......

    #指定用于支持coreapi的Schema
    'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.coreapi.AutoSchema'
}

3、在全局路由条目中,定义路由条目

from rest_framework.documentation import include_docs_urls

path('docs/',include_docs_urls(title='接口测试平台API文档',description='这个是接口平台的文档')),

4、访问接口文档

http://192.168.17.129:8000/docs/
在这里插入图片描述

方式二:

使用drf-yasg

1、安装

pip install drf-yasg

2、添加到settings.py文件中的INSTALLED_APPS(子应用)中

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'drf_yasg',         #生成接口文档子应用
    'projects',
    'interfaces',
    'django_filters'    #DRF过滤器子应用

]

3、配置,到全局路由文件中

from django.contrib import admin
from django.urls import path, re_path, include
from rest_framework.documentation import include_docs_urls

from projects import views

# drf_yasg 从这里开始
from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi

schema_view = get_schema_view(
    openapi.Info(
        title="Tweet API",
        default_version='v1',
        description="Welcome to the world of Tweet",
        terms_of_service="http://api.zhilong.site",
        contact=openapi.Contact(email="1181068365@qq.com"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),  # 权限类
)

4、指定路由条目

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path('',include('projects.urls')),

    path('docs/',include_docs_urls(title='接口测试平台API文档',description='这个是接口平台的文档')),

    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),  # <-- 这里
    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),  # <-- 这里
    path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),  # <-- 这里

]

5、访问接口文档

在这里插入图片描述

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/123274.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!