26、测试、调试、文档编写与部署监控全解析

测试、调试、文档编写与部署监控全解析

一、测试、调试与文档编写

1.1 文档生成

可以使用 Swagger inspector 生成文档。在 Express.ts 中添加以下代码来生成 Swagger UI：

app.use('/api-docs', swaggerUi.serve,
swaggerUi.setup(swaggerDocument));
app.use('/api/v1', router);

Swagger 是一个出色的文档工具，生成的文档易于理解，符合 OpenAPI 规范，被 Netflix、Yelp、Twitter 和 GitHub 等领先公司广泛使用。

1.2 从 Swagger 定义生成项目

具体步骤如下：
1. 查看提取的 src 中更新后的 hello_world_swagger.yml，它增加了一个用于更新产品信息的 API 路由/端点。
2. 从 https://github.com/swagger-api/swagger-codegen 下载 swagger-code-gen，也可以在提取的源代码中找到。
3. 由于该项目在 JVM 上运行，运行命令 mvn package 来构建 JAR。
4. 生成源代码：

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar