什么是 Swagger
Swagger 是一组开源软件工具，它们用于设计、构建、编写和维护 RESTful API。
Swagger Specification 定义了一种 API 描述格式，这种格式可以用来描述 RESTful API，包括它们的请求、响应、参数、路由等等。
Swagger UI 是一种自动生成的 HTML 文档，可以让开发者更容易的查看和测试 RESTful API。
为什么要使用 build-swagger
build-swagger 是一个只需要一份 Swagger UI 配置文件，就可以方便地搭建一个 SPA 程序的小工具。它支持本地构建和部署，同时支持在线发布。
build-swagger，能够帮助您轻松地将 Swagger UI 整合到你的项目中，只需要通过一些简单的配置即可轻松地实现 API 显示和测试功能。
如何使用 build-swagger
安装 build-swagger
npm install --save-dev build-swagger
初始化项目
npx init
配置 Swagger UI
修改项目根目录下的 swagger.config.js 配置文件，这里是一个示例配置：
-------------- - -
------ ---- -----------
-------- --------
----------- ---------------------------------------------
----- ----------------------
------- -
-------- ----------
---------- ---------
-
-- ------ ------------- ---
-- --------------------------------------------------
--其中 title 是标题，baseUrl 是页面的 URL 前缀，swaggerUrl 是 Swagger API JSON 文件的 URL，logo 是 logo 的图片 URL，colors 是颜色配置。
构建项目
运行构建命令：
npx run build
构建后会生成一个静态文件目录 ./build，将这个文件夹上传到你的 web 服务器中即可。
结语
build-swagger 能够帮助开发者在项目中方便地添加 Swagger UI，以便于开发者查看和测试 API，同时在线发布和部署也更加方便。如果你是前端开发人员，这个小工具可以大大提高责任感，看起来也蛮好看的，而且也能做一些其他有用的事情。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066c8dccdc64669dde5533