最近做的项目需要对外提供接口,由于处于开发测试阶段,接口可能随时会修改。考虑到接口一变更,对应的接口文档也需要不断修改,所以就引入了在线接口文档swagger-bootstrap-ui 直接提供在线接口文档供调用方查看。在正式引入前,搭建demo测试没问题,效果如下
关于springboot整合swagger-bootstrap-ui网上有好多教程,我看的是这篇SpringBoot集成Swagger-Bootstrap-UI
好,既然没问题,那直接引入项目,欸,这是怎么回事, 怎么会报错
看报错信息是没有doc.html的映射,突然记起来我项目中有使用thymeleaf模板引擎,而且对thymeleaf的静态资源做了单独处理
doc.html也是静态资源,需要单独处理,打开swagger-bootstrap-ui的包,看到doc.html是放在META-INF/resources/下的
于是在MVCConfig添加对doc.html的请求处理
此时访问又出现了问题,页面有加载到但是样式丢了
debug发现doc.html调用的样式资源在/webjars/**路径下
再配置对样式等静态资源的请求处理
现在访问,一切OK
MvcConfig内容如下
@Configuration
public class MvcConfig extends WebMvcConfigurationSupport {
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
// 将url为 /static/** 的请求映射到 /static/ 路径下进行查找
registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}