添加快速索引文件

common-openapi/AGENTS.md

@@ -0,0 +1,20 @@
+# Common OpenAPI 模块指引
+
+## 职责边界
+
+- 为 Spring MVC 服务提供 SpringDoc/OpenAPI 自动配置和统一文档元数据。
+- 不在这里维护具体业务接口契约；服务专属 OpenAPI 文件留在对应服务资源目录。
+
+## 快速索引
+
+| 功能 | 入口 |
+|---|---|
+| 自动配置 | `src/main/java/com/baiyue/common/openapi/BaiyueOpenApiAutoConfiguration.java` |
+| `baiyue.openapi` 配置项 | `src/main/java/com/baiyue/common/openapi/OpenApiProperties.java` |
+| 自动配置注册 | `src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports` |
+
+## 修改与验证
+
+- 调整分组、标题或安全方案时检查所有 MVC 服务的 Swagger 输出；Gateway 的 WebFlux 聚合配置在 `gateway/`。
+- 配置项变化优先保持旧键兼容，并同步 Nacos 模板。
+- 从父目录运行 `mvn -pl common-openapi -am test`。