在前端开发中，编写 API 文档是一个必不可少的环节。API 文档可以方便后端开发人员和前端开发人员之间的合作，同时也可以为产品经理、测试人员等提供参考。本文将介绍如何在快速为 Express.js 应用程序编写 API 文档。
第一步：安装 Swagger UI
Swagger UI 是一个开源的、交互式的、实时的 API 文档工具，可以帮助开发人员更快地编写和测试 API。我们可以通过 npm 安装 Swagger UI：
npm install swagger-ui-express
第二步：编写 API 文档
在 Express.js 应用程序中，我们可以使用 Swagger UI 提供的注释语法编写 API 文档。例如，我们可以在路由函数上添加注释，指定该路由的请求方法、请求路径、请求参数等信息。下面是一个示例代码：
-- -------------------- ---- ------- --- - -------- - ------- - ---- - -------- ------ - ------------ ------ - ---------- - ---- - ------------ -- - ------- - ----- ----- - ------ - ----- -------------------- - ----- - -------- ---- - ------------ ---- - ----------- - - ----- -------- - --- -------- - --------- ---- - ----- ------ - ------------ --- - - ----- -------- - --- -------- - --------- ---- - ----- ------ - ------------ -- - ---------- - ---- - ------------ -- - ------- - ----- -------------------- --
在上面的示例代码中，我们为 /users 路由添加了两个请求方法：get 和 post。对于 get 方法，我们指定了它的 summary、description 和 responses；对于 post 方法，我们指定了它的 summary、description 和 parameters。在这些注释中，我们可以使用 Swagger UI 提供的语法指定请求方法、请求路径、请求参数、响应参数等信息。
第三步：启动 Swagger UI
在编写完 API 文档之后，我们需要启动 Swagger UI 以便查看和测试 API。我们可以在 Express.js 应用程序中添加如下代码：
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));在上面的代码中，我们首先引入了 swagger-ui-express 和 swagger.json 文件。然后，我们使用 app.use() 方法将 Swagger UI 显示在 /api-docs 路由上。
总结
通过本文的介绍，我们学习了如何在快速为 Express.js 应用程序编写 API 文档。我们需要安装 Swagger UI，并使用其提供的注释语法编写 API 文档。最后，我们启动 Swagger UI 以便查看和测试 API。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65f104bd2b3ccec22f9d7abf