maira-cli
MairaCLI是一个开发者工具,旨在通过拦截请求和响应来自动生成端点的swagger文档,同时测试API端点。
列在类别中:
开发工具类别开源
描述
MairaCLI 是一款开发者工具,旨在通过在测试期间拦截请求和响应,自动生成 API 端点的 Swagger 文档。
如何使用 maira-cli?
要使用 MairaCLI,请通过 npm 安装它,在您的后端项目中启动代理服务器,在 config.json 文件中配置必要的详细信息,并通过代理服务器向后端发出请求。在发出请求后,使用提供的命令生成文档。
核心功能 maira-cli:
1️⃣
自动生成 API 端点的 Swagger 文档
2️⃣
拦截请求和响应以确保文档准确性
3️⃣
为项目路由创建配置文件
4️⃣
生成文档预览链接
5️⃣
支持自定义认证头
为什么要使用 maira-cli?
# | 使用案例 | 状态 | |
---|---|---|---|
# 1 | 为后端项目生成 API 文档 | ✅ | |
# 2 | 在记录 API 的同时测试 API 端点 | ✅ | |
# 3 | 为微服务创建 Swagger 文档 | ✅ |
开发者 maira-cli?
MairaCLI 由 GitHub 上的贡献者社区开发,旨在简化开发者的 API 文档编写过程。