MarsMgn

外观

接口文档 ​

drf-spectacula ​

介绍 ​

drf-spectacular 是一个基于 DRF 的 API 文档生成工具，支持 OpenAPI 3.0规范，并提供了自动生成文档和交互式文档页面的功能。

使用接口文档 ​

启动项目后端，打开浏览器，接口文档地址：http://127.0.0.1:8000/api/schema/swagger-ui/

image-20250615165152998

登录获取accessToken

  • 找到接口——使用账号密码登录，点击Try it out

  • 输入用户名：admin`` 密码：``admin123 ，点击Execute

  • 会返回accessToken等结果

    image-20251104150321683

image-20251104150501986

授权接口文档

  • 复制上一步获取的accessToken，点击接口文档顶部的Authorize按钮
  • 粘贴accessToken进行授权
  • 授权后，能正常调用其它接口，不会显示“账号未登录”

image-20251104150700732

接口文档配置（可选） ​

配置接口文档访问地址，配置文件：mysite\mysite\urls.py

image-20250616080401774

TIP

目前，使用drf-spectacula自动生成的接口文档，小部分请求参数不正确。欢迎贡献。

Apifox ​

介绍 ​

Apifox 是一款 API 设计、开发、测试一体化协作平台，它融合了多个工具的优势，能够帮助团队提升 API 开发效率和质量。除了上面第一种方式访问接口文档，更推荐使用Apifox这个免费主流工具。

Apifox下载地址

image-20250616080739092

新建项目 ​

打开Apifox，点击“主窗口——新建项目”

image-20250616082645554

点击进入新建的项目，鼠标悬停在+号，选择“导入”

image-20250616082908117

启动项目后端，URL方式导入填写地址：http://127.0.0.1:8000/api/schema/

image-20250616083448767

点击继续，完成导入。

开发环境设置 ​

管理后台-system-认证，使用账号密码登录，填写用户名和密码，成功登录后能获取accessToken

image-20250629150727443

添加后置操作，如下图所示。设置后再次点击发送

image-20250629151121323

点击开发环境

  • 此时可以看到自动添加的accessToken变量

image-20250629151329254

  • 点击全局参数，添加Authorization参数，如下图所示。

image-20250629152417575

访问其它API ​

经过上一步开发环境设置，现在访问其它API会自动带上accessToken认证。

image-20250629152816846