Django REST framework 集成 Swagger 生成 API 文档详解

集成 Swagger 生成 API 文档

在 Django REST framework 项目中，集成 Swagger 可以自动生成可视化的 API 文档，方便前后端联调。以下是具体的操作步骤：

1. 安装依赖库

首先，需要安装 django-rest-swagger 库。在终端中执行以下命令：

pip install django-rest-swagger

2. 配置 settings.py

在项目根目录下的 settings.py 文件中，进行以下配置：

• 在 INSTALLED_APPS 中添加 'rest_framework_swagger'。
• 在 REST_FRAMEWORK 配置中，设置默认的模式类为 'rest_framework.schemas.AutoSchema'。

INSTALLED_APPS = [
    # 其他应用...
    'rest_framework_swagger',
]

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
}

3. 配置 urls.py

在项目根目录下的 urls.py 文件中，导入 get_swagger_view 并配置路由：

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='API文档')

urlpatterns += [
    path('docs/', schema_view),
]

4. 访问 API 文档

完成上述配置后，启动 Django 项目。在浏览器中访问 http://127.0.0.1:8000/docs/（假设默认端口为 8000），即可看到生成的 Swagger API 文档界面。

总结

通过集成 Swagger，Django REST framework 项目可以快速生成直观、交互式的 API 文档，极大提升了开发效率和团队协作体验。

以上就是 Django REST framework 生成 API 文档的详细内容，更多关于 Django,REST framework,Swagger,API文档,Python 的资料请关注本站其它相关文章！