标签:组织机构 组织 首页 图片 schema shortcut templates esc get
1 在配置文件中增加接口文档配置
REST_FRAMEWORK = { ‘DEFAULT_SCHEMA_CLASS‘: ‘rest_framework.schemas.AutoSchema‘, }
2 在APP的Templates目录下创建一个文件org-home.py
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <h1>组织首页</h1> </body> </html>
3 在APP的views目录下创建一个文件OrgHome.py
from django.shortcuts import render from rest_framework import mixins from rest_framework.viewsets import GenericViewSet class OrgHomeViewSet(GenericViewSet): def list(self, request, *args, **kwargs): """ 【功能描述】用于获取组织首页页面</br> 【操作步骤】从第一步开始操作到最后一步</br> 【返回值】暂时没写</br> """ return render(request, ‘org-home.html‘)
4 配置APP分路由 urls
from django.urls import path from Applications.Organization.views import OrgHome urlpatterns = [ path(‘OrgHome/‘, OrgHome.OrgHomeViewSet.as_view({‘get‘: ‘list‘})), ]
5 配置工程主路由
from django.contrib import admin from django.urls import path, include from rest_framework.documentation import include_docs_urls DESCRIPTION = """ 包括仝恒绩效云所有接口文档。包括以下应用: 1 Authentication:认证服务应用 2 Organization: 组织机构应用 """ urlpatterns = [ path(‘admin/‘, admin.site.urls), path(‘Organization/‘, include(‘Applications.Organization.urls‘)), path(‘docs/‘, include_docs_urls(title=‘接口文档‘,description=DESCRIPTION)), ]
6 运行工程,输入IP/docs/可看到如下接口文档效果
标签:组织机构 组织 首页 图片 schema shortcut templates esc get
原文地址:https://www.cnblogs.com/dorian/p/12348368.html