在Ubuntu上使用Swagger進行API版本管理,可以參考以下步驟:
添加Swagger依賴:首先,需要在你的項目中添加Swagger的依賴。如果你使用的是Spring Boot項目,可以在pom.xml
文件中添加Swagger的依賴項。
創建Swagger配置類:接下來,創建一個Swagger配置類,用于定義不同版本的API文檔。在這個配置類中,可以使用Docket
實例來定義每個版本的API文檔,并通過groupName
方法為每個版本指定一個組名。
例如:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket apiV1() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("v1")
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.ant("/api/v1/**"))
.build();
}
@Bean
public Docket apiV2() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("v2")
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.ant("/api/v2/**"))
.build();
}
}
@RequestMapping
注解來指定每個版本的API路徑。例如:
@RestController
@RequestMapping("/api/v1")
public class ApiControllerV1 {
@GetMapping("/hello")
public String hello() {
return "Hello from API v1!";
}
}
@RestController
@RequestMapping("/api/v2")
public class ApiControllerV2 {
@GetMapping("/hello")
public String hello() {
return "Hello from API v2!";
}
}
http://localhost:8080/swagger-ui.html
),你將看到兩個版本的API文檔,分別位于/api/v1
和/api/v2
路徑下。通過這種方式,你可以在Ubuntu上使用Swagger來管理API的不同版本,并且可以輕松地切換不同版本的API文檔。