从禁用到启用：MeterSphere后端API文档全攻略

你是否在使用MeterSphere时，苦于找不到完整的API文档？想调用接口却不知从何下手？本文将带你一步步解锁MeterSphere后端API文档功能，让接口调用不再是难题。读完本文，你将学会如何启用Swagger文档、访问API界面、理解接口结构并成功调用接口。

项目概述

MeterSphere是一站式开源持续测试平台，为软件质量保驾护航。搞测试，就选 MeterSphere！

Swagger配置现状

在MeterSphere项目中，Swagger相关配置默认是禁用的。我们可以在backend/app/src/main/resources/commons.properties文件中看到以下配置：

# swagger docs config
springdoc.swagger-ui.enabled=false
springdoc.api-docs.enabled=false
springdoc.api-docs.groups.enabled=true

启用Swagger文档

要启用Swagger文档功能，需要修改上述配置，将springdoc.swagger-ui.enabled和springdoc.api-docs.enabled设置为true：

springdoc.swagger-ui.enabled=true
springdoc.api-docs.enabled=true

访问Swagger UI界面

启用配置后，启动MeterSphere后端服务，通过以下地址访问Swagger UI界面：

http://localhost:8081/swagger-ui.html

在项目代码中，我们可以看到backend/framework/sdk/src/main/java/io/metersphere/sdk/util/FilterChainUtils.java文件中已经配置了对Swagger UI路径的匿名访问权限：

filterChainDefinitionMap.put("/swagger-ui.html", "anon");

API接口调用示例

以API测试模块为例，调用获取测试用例列表接口的步骤如下：

1. 打开Swagger UI界面，找到case-management相关接口组
2. 选择/api/case/list接口，点击"Try it out"
3. 填写请求参数，如项目ID、页码、每页条数等
4. 点击"Execute"发送请求，查看返回结果

常见问题解决

访问Swagger UI提示404

检查commons.properties中的配置是否已启用，服务是否重启生效。

接口调用提示未授权

确保在请求头中添加了正确的认证信息，如Token。

总结

通过修改配置启用Swagger文档后，我们可以方便地查看和测试MeterSphere后端API接口。Swagger UI提供了直观的界面和交互方式，帮助我们快速熟悉接口功能和参数要求，提高开发和测试效率。

后续我们可以进一步探索如何自定义API文档信息，如标题、描述、版本等，让文档更加完善和易用。

希望本文对你使用MeterSphere的API接口有所帮助，如有任何问题，欢迎在项目社区中交流讨论。