SpringCloud整合Swagger3
Spring Cloud整合Swagger3的步骤如下:
- 在Spring Cloud项目的
pom.xml
中添加Swagger3的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
- 创建Swagger配置类,通常是一个
@Configuration
类,如下:
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.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")
.description("Your API Description")
.version("1.0.0")
.license(new License().name("Your License").url("https://yourlicense.com")));
}
}
- 确保Spring Cloud项目的
application.properties
或application.yml
中没有禁用Swagger的配置。 - 启动Spring Cloud应用,并访问
http://<host>:<port>/swagger-ui/index.html
来查看Swagger的API文档页面。
以上步骤可以整合Swagger3到Spring Cloud项目中。如果需要针对不同的分布式环境或者微服务架构进行额外配置,可能需要添加路由配置或者修改安全策略等。
评论已关闭