danielgtaylor/apisprout

API Sprout 镜像说明

镜像概述

API Sprout是一款轻量、跨平台的API模拟服务器，能够根据OpenAPI 3.x描述文档返回示例数据，支持请求验证、内容协商等功能，适用于API原型开发、前端测试和接口文档验证场景。

核心功能

• 支持OpenAPI 3.x规范，可从examples字段读取示例或通过schema自动生成示例
• 支持从本地文件或URL加载API文档，开启--watch可自动重载
• 默认启用CORS headers，方便跨域请求
• 支持Accept头内容协商（如Accept: application/*）
• 支持Prefer头选择特定响应状态（如Prefer: status=409）
• 可开启服务器验证（--validate-server），验证scheme、主机名/端口和基础路径
• 可开启请求参数与body验证（--validate-request）
• 支持多种配置方式：文件（/etc/apisprout/config.json|yaml）、环境变量（前缀SPROUT_）、命令行参数

使用场景

1. API原型开发：快速构建API接口，无需后端实现即可供前端调试
2. 前端测试：模拟不同响应状态（成功、错误等），验证前端逻辑
3. 接口文档验证：检查OpenAPI文档的正确性和完整性
4. 团队协作：统一API接口规范，减少沟通成本

配置说明

命令行参数示例

sh
# 从本地文件加载API文档
apisprout my-api.yaml

# 开启服务器验证并使用基础路径
apisprout --validate-server my-api.yaml

# 动态添加服务器并开启验证
apisprout --add-server http://localhost:8080/mock --validate-server my-api.yaml

# 从URL加载API文档
apisprout https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/api-with-examples.yaml

Docker部署示例

拉取镜像

sh
docker pull danielgtaylor/apisprout

从URL运行模拟服务器

sh
docker run -p 8000:8000 danielgtaylor/apisprout http://example.com/my-api.yaml

使用本地API文档文件

sh
# 替换$FULLPATH为本地API文档的绝对路径
docker run -p 8000:8000 -v $FULLPATH/localfile.yaml:/api.yaml danielgtaylor/apisprout /api.yaml

通过环境变量配置

sh
docker run -p 8000:8000 -e SPROUT_VALIDATE_REQUEST=1 danielgtaylor/apisprout http://example.com/my-api.yaml

额外功能

• 远程重载：若从远程URL加载API文档，可访问/__reload端点实现实时重载
• 健康检查：访问/__health端点可获取状态码200（即使开启服务器验证）

许可证

该镜像基于MIT许可证发布，详情请参考MIT License