11.1

zhangbo/第八天技术学习笔记.txt

@@ -0,0 +1,34 @@
+今日学习笔记：Swagger 与前后端分离接口管理
+
+一、Swagger 核心认知
+定位：Swagger（现归属 OpenAPI 规范）是目前前后端分离场景中最流行的 API 接口文档生成与管理工具。
+跨语言支持：不仅适用于 Java（如 Spring Boot），还支持 Python、Node.js、Go 等多种编程语言，通用性极强。
+核心价值：解决传统接口文档“维护成本高、与代码不同步、无法直接调试”等痛点。
+
+二、Swagger 核心功能
+自动生成接口文档
+   基于代码注解实时生成文档，代码变更时文档自动更新，避免“文档过期”问题。
+   
+增强接口可读性 
+   可对复杂属性、接口逻辑添加详细注释（如参数含义、返回值说明、业务场景），降低前后端沟通成本。
+   
+在线调试接口
+   提供可视化 UI 界面（Swagger UI），支持直接填写参数、发送请求、查看响应，无需依赖 Postman 等工具。
+   
+规范接口设计
+   强制遵循 OpenAPI 规范，统一接口的路径、参数格式、返回值结构，提升团队协作效率。
+
+三、Spring Boot 集成 Swagger 核心步骤
+1. 引入依赖
+   
+2. 配置 Swagger
+   创建配置类，定义文档基本信息（标题、描述、版本等）：  
+
+3. 添加接口注释
+   使用 Swagger 注解增强文档可读性：  
+  
+4. 访问 Swagger UI
+   启动项目后，通过 `http://localhost:端口号/swagger-ui/index.html` 访问可视化界面，可查看文档并在线调试。
+
+Swagger 前后端分离项目中接口管理，核心优势在于文档实时同步和在线调试。
+通过 Spring Boot 集成后，可快速为接口添加注释，降低团队沟通成本。