Swagger 是一种基于 RESTful 的接口文档约定，通过 Swagger 我们可以快速生成 API 文档和提供 API 的调用示例。而 swagger-runner 是一个 npm 包，可以帮助我们在本地跑起一个 swagger API，方便我们进行开发和调试。
安装 swagger-runner
首先，我们需要全局安装 swagger-runner：
npm install -g swagger-runner
使用 swagger-runner 构建本地 API
在安装好 swagger-runner 后，我们可以在本地搭建一个 Swagger API，可以参考官方 swagger-sample-app 指南。具体来说，使用以下命令：
git clone https://github.com/swagger-api/swagger-sample-app.git cd swagger-sample-app swagger project start
上面的命令会从 GitHub 上克隆官方的示例应用并启动应用程序。另外，swagger-runner 也提供其他命令帮助我们更方便地启动应用程序。
swagger project start --port 3001 --host localhost
上面的命令会在本地启动一个 API，端口为 3001，须指定参数。然后我们可以在浏览器中访问 http://localhost:3001/docs 或者使用 Swagger UI 对这个 API 进行测试和交互。
使用 swagger-runner 测试 API
Swagger UI 是一个交互的 API 文档，我们可以通过填写参数和运行测试来主动测试 API 的功能。
本地启动的 API 应该已经有一些接口了，我们可以选择一个接口进行测试，比如通过 GET 方法获取用户信息，因为这个接口不需要参数。我们点击左侧菜单的 user，然后选择 GET /user/{id} 接口，点击进入到接口详情。在右侧的窗口中，我们可以看到这个接口的详细信息，以及它的请求和响应示例。
在 Swagger UI 中，我们可以直接向 API 提交请求和查看响应，下图展示了在 Swagger UI 中发送请求和获取响应的例子。
总结
Swagger-runner 是一个非常有用的工具，可以帮助我们快速搭建并测试本地 API，同时也可以帮助我们更方便地开发和调试 API。
这篇文章介绍了如何使用 swagger-runner 构建本地 API，并在 Swagger UI 中主动测试它。如果你想要更深入地学习 Swagger，你可以查阅官方文档，链接为 https://swagger.io/。
示例代码
无代码示例。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005596481e8991b448d6e29