app网站开发住房公积金网站建设项目教程

低版的spring boot 1.X接入knife4j

老的项目是用spring boot 1.5.10.RELEASE 不好升级 ，原来接口文档一直用的是老的swagger样式，不是很好看，网上查了下，发现有个knife4j挺好看的，用一下他们的样式，下面是接入详细
Maven中引入Jar包
由于是springfox-swagger的增强UI包,所以基础功能依然依赖Swagger,springfox-swagger的jar包必须引入

io.springfox springfox-swagger2 2.9.2 然后引入SwaggerBootstrapUi的jar包 com.github.xiaoymin swagger-bootstrap-ui ${lastVersion} 编写Swagger2Config配置文件 Swagger2Config配置文件如下：

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.bycdao.cloud”))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(“swagger-bootstrap-ui RESTful APIs”)
.description(“swagger-bootstrap-ui”)
.termsOfServiceUrl(“http://localhost:8999/”)
.contact(“[e-mail]”)
.version(“1.0”)
.build();
}
}
访问地址
swagger-bootstrap-ui默认访问地址是：http://$host:${port}/doc.html

注意事项
Springfox-swagger默认提供了两个Swagger接口,需要开发者放开权限(如果使用shiro权限控制框架等)，如果使用SwaggerBootstrapUi的增强功能,还需放开增强接口地址,所以，放开的权限接口包括3个，分别是：

/swagger-resources:Swagger的分组接口
/v2/api-docs?group=groupName:Swagger的具体分组实例接口,返回该分组下所有接口相关的Swagger信息
/v2/api-docs-ext?group=groupName:该接口是SwaggerBootstrapUi提供的增强接口地址,如不使用UI增强,则可以忽略该接口
Shiro的相关配置实例如下：

/swagger-resources = anon /v2/api-docs = anon /v2/api-docs-ext = anon /doc.html = anon /webjars/** = anon

    //others....
</value>    

SpringBoot中访问doc.html报404的解决办法

实现SpringBoot的WebMvcConfigurer接口，添加相关的ResourceHandler,代码如下：

@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class SwaggerBootstrapUiDemoApplication implements WebMvcConfigurer{

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

}
使用SpringMvc的朋友.在web.xml中配置了DispatcherServlet,则需要追加一个url匹配规则,如下

cmsMvc org.springframework.web.servlet.DispatcherServlet contextConfigLocation classpath:config/spring.xml 1 cmsMvc *.htm cmsMvc /v2/api-docs cmsMvc /swagger-resources cmsMvc /v2/api-docs-ext

UI效果图
接口说明

接口调试

个性化设置

接口离线文档