Django-REST-Framework 如何快速生成Swagger, ReDoc格式的 REST API 文档

在Django REST Framework中，你可以使用coreapi库来生成Swagger格式的API文档，并使用drf-yasg库来生成ReDoc格式的API文档。以下是如何安装和配置的步骤：

1. 安装coreapi和drf-yasg：

pip install coreapi drf-yasg

2. 在你的Django项目的settings.py文件中添加coreapi和drf-yasg到INSTALLED_APPS：

INSTALLED_APPS = [
    # ...
    'coreapi',
    'drf_yasg',
    # ...
]

3. 在urls.py中添加路由以使Swagger/ReDoc可访问：

from django.urls import include, path
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
 
schema_view = get_schema_view(
    openapi.Info(
        title="Your API title",
        default_version='v1',
        description="Your API description",
        terms_of_service="https://www.your-tos.com",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
)
 
urlpatterns = [
    # ...
    path('swagger<format>/', schema_view.without_ui(cache_timeout=0), name='schema-json'),
    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'),
    # ...
]

现在，当你访问http://your-domain/swagger/和http://your-domain/redoc/时，你将看到Swagger和ReDoc格式的API文档。