Django自动生成docs接口文档

本文主要是介绍Django自动生成docs接口文档，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1.创建Django项目

python manage.py startproject django2025

2.创建子应用

python manage.py startapp api

3.安装依赖包

pip install coreapi

4.创建urls.py

from django.contrib import admin
from django.urls import path, include
from rest_framework import routers
from api.views import MyAPIView
from rest_framework.schemas import get_schema_view
from rest_framework.documentation import include_docs_urls
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(openapi.Info(title="API Documentation",default_version='v1',),public=False
)
urlpatterns = [path('admin/', admin.site.urls),path(r'docs/', include_docs_urls(title='API文档')),path('api/hello/', MyAPIView.as_view()),
]

5.编写view.py视图

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.schemas import AutoSchemaclass MyAPIView(APIView):"""A simple API View with GET and POST methods."""schema = AutoSchema()  # 自动创建API文档的Schemadef get(self, request, *args, **kwargs):response = {'message': 'Hello, World!'}return Response(response)def post(self, request, *args, **kwargs):response = {'message': 'Got some data!', 'data': request.data}return Response(response)

6.访问页面检查

http://127.0.0.1:8000/docs/

这篇关于Django自动生成docs接口文档的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---