django(REST_FRAMEWORK)+swagger+Apifox 集成

1.reset_framework

1.1安装rest_framework

1.2使用rest_framework

在django框架中setting文件中注册rest_framework

INSTALLED_APPS = [
    'rest_framework',
]

2.reset_framework+swagger

2.1.安装drf_yasg

2.2.在django框架中setting文件中注册drf_yasg

INSTALLED_APPS = [
    'drf_yasg',
]

2.3.在setting文件中新增如下配置

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            # os.path.join(BASE_DIR, 'templates'),
            # os.path.join(BASE_DIR, 'drf-yasg', 'templates'),
            # os.path.join(BASE_DIR, 'templates')
        ],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

2.4在对应url中配置swagger

from drf_yasg.views import get_schema_view
from drf_yasg import openapi

schema_view = get_schema_view(
    openapi.Info(
        title="API接口文档平台",  # 必传
        default_version='v1',  # 必传
        description="这是一个接口文档",
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    # permission_classes=(permissions.AllowAny,),   # 权限类
)

urlpatterns = [
    path('admin/',admin.site.urls),
    path('api-auth/', include('rest_framework.urls')),
    path('newProjectApp/',include('newProjectApp.urls')),
    # 以下是swagger路由配置
    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'),

]

2.5启动django服务

3.reset_framework+swagger+Apifox

3.1安装apifox扩展件或者下载对应的apifox桌面端

tips:1.需要手动刷新扩展件之后 或者手动刷新当前访问apifox网页端的页面

  • 4
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
好的,下面是一个使用 DjangoDjango REST frameworkSwagger后端框架 demo。 首先,需要安装 DjangoDjango REST frameworkSwagger: ``` 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 frameworkSwagger 的配置: ```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/`,即可看到 SwaggerAPI 文档界面。在其中可以看到一个名为 `hello` 的 API,点击该 API 可以进行测试,测试结果将会返回一个字符串 "Hello, world!"。 这就是使用 DjangoDjango REST frameworkSwagger 编写的一个后端框架 demo。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小赖同学啊

跟着大师走,路不会太差

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值