1回答

bobby

2025-04-28

已采纳

从 DRF (Django REST Framework) 3.11 版本开始，官方正式弃用了 coreapi，并转向基于 OpenAPI 3 规范的文档生成方式。以下是新版本中生成 API 文档的解决方案和推荐工作流：

1. 使用 drf-spectacular（官方推荐）

DRF 官方推荐使用第三方库 drf-spectacular 生成 OpenAPI 3 规范的文档。它功能强大且兼容性更好。

步骤：

1. 安装依赖：

   
   

   pip install drf-spectacular

2. 配置 settings.py：

   
   

   INSTALLED_APPS = [
       # ...
       'drf_spectacular',]REST_FRAMEWORK = {
       'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',}

3. 生成文档 URL（在 urls.py 中）：

   
   

   from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
   
   urlpatterns = [
       # ...
       path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
       path('api/docs/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
       path('api/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),]

4. 访问文档：

• Swagger UI: http://localhost:8000/api/docs/

• ReDoc: http://localhost:8000/api/redoc/

0

0