DRF生成swagger文档

最近在做一个项目,重新搭建了drf项目,为了规范决定引入swagger文档1.安装drf-yasgpip install drf-yasg2.在setting里面引入INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages
摘要由CSDN通过智能技术生成

最近在做一个项目,重新搭建了drf项目,为了规范决定引入swagger文档

1.安装drf-yasg

pip install drf-yasg

2.在setting里面引入

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',  # 注册django-rest framework
    'drf_yasg', # swagger文档
]

3.新建一个py文件,我这里是在settings.py同级新建views.py文件,内容如下

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
# swagger文档
schema_view = get_schema_view(
    openapi.Info(
        title="API",
        default_version='v1',
        description="系统API文档",
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),
)

4.新增url路由

    path('swagger/', schema_view.with_ui('swagger',
         cache_timeout&#
  • 2
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 8
    评论
好的,下面是一个使用 Django、Django REST framework 和 Swagger 的后端框架 demo。 首先,需要安装 Django、Django REST framework 和 Swagger: ``` pip install Django pip install djangorestframework pip install django-rest-swagger ``` 接着,创建一个 Django 项目: ``` django-admin startproject demo ``` 然后,在项目根目录下创建一个名为 `api` 的 Django app: ``` cd demo python manage.py startapp api ``` 接下来,修改 `demo/settings.py` 文件,将 `api` app 添加到 `INSTALLED_APPS` 列表中: ```python INSTALLED_APPS = [ # ... 'rest_framework', 'rest_framework_swagger', 'api', ] ``` 然后,在 `api` app 下创建一个名为 `views.py` 的文件,用于编写 API 视图函数: ```python from rest_framework.decorators import api_view from rest_framework.response import Response @api_view(['GET']) def hello(request): """ 返回一个简单的字符串 """ return Response("Hello, world!") ``` 接着,在 `api` app 下创建一个名为 `urls.py` 的文件,用于配置 API 路由: ```python from django.urls import path from rest_framework_swagger.views import get_swagger_view from . import views schema_view = get_swagger_view(title='API文档') urlpatterns = [ path('', schema_view), path('hello/', views.hello), ] ``` 最后,修改 `demo/settings.py` 文件,设置 REST framework 和 Swagger 的配置: ```python REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' } SWAGGER_SETTINGS = { 'SECURITY_DEFINITIONS': { 'Basic': { 'type': 'basic' } }, } ``` 现在,运行 Django 项目: ``` python manage.py runserver ``` 在浏览器中访问 `http://127.0.0.1:8000/api/`,即可看到 Swagger 的 API 文档界面。在其中可以看到一个名为 `hello` 的 API,点击该 API 可以进行测试,测试结果将会返回一个字符串 "Hello, world!"。 这就是使用 Django、Django REST framework 和 Swagger 编写的一个后端框架 demo。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 8
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值