Spring Boot 开发 -- swagger3.0 集成
在Spring Boot项目中集成Swagger 3.0,你需要按照以下步骤操作:
- 添加Swagger 3.0的依赖到你的
pom.xml
文件中。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
- 配置Swagger。创建一个配置类来定义Swagger的行为。
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("Your API Title")
.version("v1")
.license(new License().name("Apache 2.0").url("http://springdoc.org")));
}
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("public-api")
.pathsToMatch("/api/v1/**")
.build();
}
}
- 在
application.properties
或application.yml
中配置Swagger。
# application.properties
springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.operationsSorter=method
springdoc.swagger-ui.tagsSorter=alpha
- 确保你的Spring Boot应用启动类上有
@EnableSwagger2
注解(如果使用的是Spring Fox)。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class YourApplication {
public static void main(String[] args) {
SpringApplication.run(YourApplication.class, args);
}
}
- 完成上述步骤后,你可以通过访问
http://<your-domain>/swagger-ui.html
来查看Swagger UI。
确保你的Spring Boot应用运行在指定端口,并且没有配置安全策略阻止访问Swagger UI。
评论已关闭