1.创建Django项目
python
python manage.py startproject django2025
2.创建子应用
python
python manage.py startapp api
3.安装依赖包
python
pip install coreapi
4.创建urls.py
python
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视图
python
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.schemas import AutoSchema
class MyAPIView(APIView):
"""
A simple API View with GET and POST methods.
"""
schema = AutoSchema() # 自动创建API文档的Schema
def 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.访问页面检查
python
http://127.0.0.1:8000/docs/
