Django 1.7 中的 drf-spectacular 替代品：探索 Swagger 和其他解决方案

Django 1.7 中 drf-spectacular 的替代方案：使用 Swagger 和其他解决方案

作为一名资深程序员，我一直使用 drf-spectacular 来为 Django API 生成 OpenAPI 文档。但是，当需要在 Django 1.7 中使用它时，我遇到了一个障碍。因此，我探索了其他选择，现在我将与你们分享我的发现。

drf-spectacular 的替代方案：Django REST Framework Schema Generator

Django REST Framework Schema Generator 是一个出色的替代方案，与 Django 1.7 兼容。它提供类似于 drf-spectacular 的功能，允许注释视图并生成 OpenAPI 文档。

使用步骤：

1. 安装：pip install drf-yasg
2. 添加到设置文件：

INSTALLED_APPS = [
    ...
    'drf_yasg',
]

SWAGGER_SETTINGS = {
    'DEFAULT_INFO': 'my_project.urls.api_info',
}

3. 创建 api_info.py 文件：

from drf_yasg.inspectors import SwaggerInspector
from drf_yasg.utils import swagger_auto_schema

class CustomSwaggerInspector(SwaggerInspector):
    def get_core_info(self):
        return SwaggerInspector.get_core_info(self) + {
            "x-logo": {
                "url": "https://example.com/logo.png"
            }
        }


@swagger_auto_schema(method='get')
def api_info(request):
    """
    API Info
    """
    return Response({})

4. 包含 drf_yasg.urls：

from django.urls import path, include

urlpatterns = [
    ...
    path('swagger/', include('drf_yasg.urls')),
]

探索其他解决方案

除了 Django REST Framework Schema Generator，还有其他解决方案：

• Swagger UI： 一个独立工具，用于查看和交互 API 文档。
• ReDoc： 另一个独立工具，提供交互式文档界面。
• 手动注释： 编写 OpenAPI 文档并使用 Swagger UI 或 ReDoc 呈现。

结论

尽管 drf-spectacular 无法直接用于 Django 1.7，但 Django REST Framework Schema Generator 等替代方案可以胜任这项工作。根据你的需求，还有其他选择，如 Swagger UI、ReDoc 或手动注释。仔细考虑每个选项，找到最适合你的方法。

常见问题解答

1. 为什么 drf-spectacular 无法在 Django 1.7 中使用？
   它依赖于 Django 2.2，与 Django 1.7 不兼容。

2. Django REST Framework Schema Generator 与 drf-spectacular 有什么区别？
   它们的功能相似，但 Django REST Framework Schema Generator 与 Django 1.7 兼容。

3. Swagger UI 和 ReDoc 是什么？
   它们是独立工具，用于查看和交互 API 文档。

4. 何时选择手动注释？
   当你需要更精确地控制文档或需要特定的功能时。

5. 如何决定哪种方法最适合我？
   考虑你的 Django 版本、所需的特性以及你的舒适度水平。