swagger 集成
时间: 2024-12-28 22:41:11 浏览: 8
Swagger是一个流行的API设计、文档生成和发现工具,它帮助开发者描述RESTful API的行为,并自动生成用户友好的API文档。集成Swagger到项目中通常有以下几个步骤:
1. **添加依赖**:对于Spring Boot项目,可以使用Springfox库,它是Swagger UI与Spring框架整合的一个方便选择。
```java
// pom.xml文件中添加dependency
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.x.y</version> <!-- 根据最新版本更换 -->
</dependency>
```
2. **配置启用**:在应用启动类上添加`@EnableSwagger2`注解开启Swagger功能。
```java
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. **创建API注解**:使用`@Api`, `@ApiOperation`, `@RequestMapping`等注解来标记API资源和方法。
4. **扫描Controller**:配置Swagger扫描哪些Controller类以自动发现API。
5. **访问文档**:通过`http://localhost:8080/swagger-ui.html`路径打开Swagger UI界面,可以查看和测试API。
阅读全文