12、OpenAPI 文档添加与微服务数据持久化

OpenAPI 文档添加与微服务数据持久化

1. OpenAPI 描述 API

当输入负的产品 ID 时，会返回 422 - “Unprocessable Entity” 错误。

从配置中我们可以了解到：
- 属性占位符，如 ${api.responseCodes.ok.description} 会被转换为 OK 。YAML 属性文件具有层次结构，示例如下：

api:
  responseCodes:
    ok.description: OK

• 多行值以 | 开头，例如属性 api.get-composite-product.description.notes 。并且 springdoc - openapi 支持使用 Markdown 语法提供多行描述。

2. 构建和启动微服务环境

在尝试 OpenAPI 文档之前，需要构建并启动微服务环境，操作步骤如下：
1. 进入指定目录：

cd $BOOK_HOME/Chapter05

2. 执行构建命令：

./gradlew build && docker-compose build &