Swagger(分布式RPC调用和分布式文件储存)
目录
一、Swagger简介
二、Swagger机制用法
1. 集成到Spring Boot示例
三、SwaggerUI用法
四、基本信息配置
五、常用注解
总结
一、Swagger简介
Swagger 是一个开源的API文档生成工具,用于设计、构建和文档化RESTful API。它通过代码注解自动生成交互式API文档,支持多种语言(如Java、Python、Node.js等),并提供了可视化界面(Swagger UI)方便测试和调试。
核心组件:
- Swagger Core:注解库,用于标记API信息。
- Swagger UI:基于Web的交互式文档界面。
- OpenAPI/Swagger规范:定义API的JSON/YAML格式标准。
优势:
- 自动生成文档,减少手动维护成本。
- 支持在线测试API。
- 兼容多种框架(Spring Boot、Flask等)。
二、Swagger机制用法
Swagger通过 注解 解析代码中的API信息,生成元数据(如路径、参数、响应等),最终渲染为文档。
1. 集成到Spring Boot示例
依赖(Maven):
<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version>
</dependency>
配置类:
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean