1. 路径功能
/api_spec
是用于获取当前服务 API 文档的标准化路径,支持以下功能:
- 📄 查看接口定义说明
- 📊 获取请求参数格式
- 📋 下载 API 使用示例
2. 请求方式
- ✅ 只支持 GET 请求
- 🧾 参数说明:
format
:指定返回格式(json
/yaml
,默认json
)lang
:语言切换(zh
/en
,默认zh
)
3. 响应示例
{
"status": "success",
"spec": {
"version": "1.0.0",
"endpoints": [
{
"path": "/docs",
"method": "GET",
"description": "获取完整 API 文档"
},
{
"path": "/data",
"method": "POST",
"description": "提交数据处理请求"
}
]
}
}
4. 扩展阅读
如需深入了解 API 设计规范,建议访问 https://cloud-image.ullrai.com/q/API_文档/ 查看详细说明。