SuperAPI AI 工具集

scalar-mock-server

编程与开发

查看项目

更新于 10-16 09:49

技能介绍

用途:为 OpenAPI 描述文档生成真实的模拟 API 响应,并支持自定义请求行为、种子数据和 Docker 化模拟环境。运行时为 Node.js(要求 >=22),主要 API 为 createMockServer(options)。

主要能力:启动时加载 OpenAPI 文档、按 x-seed 幂等播种数据(仅当集合为空)、为声明的安全方案注册认证路由、为每个路径和方法注册路由,并在 /openapi.json 与 /openapi.yaml 暴露源文档。

使用方式:快速启动可运行 npx @scalar/cli document mock openapi.json --watch;编程方式用 createMockServer 传入 document(URL、文件路径或对象),可选 onRequest、validateRequest(设为 false 时总是返回模拟响应而非 422)、logger。x-handler 中可用 store(内存持久化)、faker、req、res(按状态码取响应示例)。x-seed 用于 components.schemas 下,键名即集合名,支持 seed.count、seed(array)、seed(factory)。Docker 运行:docker run -p 3000:3000 scalarapi/mock-server --url https://api.example.com/openapi.yaml;文档来源优先级为 --url、OPENAPI_DOCUMENT、OPENAPI_DOCUMENT_URL、挂载的 /docs。

适用场景:需要从 OpenAPI 文档获得逼真响应、自定义请求逻辑或 Docker 模拟环境的开发与测试。

限制:文档来源至少需配置一个;422 与 404/500 行为受 validateRequest 和是否提供 404 示例影响;认证路由需匹配 securitySchemes。更多细节见官方文档链接。