【补充说明】如何在JavaWeb项目中集成Swagger-UI

举报
星汉网络 发表于 2018/12/02 14:22:03 2018/12/02
3.5k+ 0 0
【摘要】 原文地址:https://bbs.huaweicloud.com/forum/thread-6358-1-1.html 【问题描述】在使用软开云接口测试的时候,导出swagger文档,是个十分优雅的操作。经过实战,发现Swagger的API文档,还是导不出来,经过深入分析,将遇到的问题再总结了一下。1、报告异常:org.springframework.beans.factory.BeanCr...

原文地址:https://bbs.huaweicloud.com/forum/thread-6358-1-1.html

image.png

【问题描述】在使用软开云接口测试的时候,导出swagger文档,是个十分优雅的操作。经过实战,发现Swagger的API文档,还是导不出来,经过深入分析,将遇到的问题再总结了一下。

1、报告异常:

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter': Instantiation of bean failed

image.png

原因是com.fasterxml.jackson.core的版本号过低,将2.6.6修改为更高版本,例如2.9.6(目前最新),问题得到解决。

2、报告异常:

1
Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gateway. The base url is the root of where all the swagger resources are served.

image.png

这个问题的原因,网络上的说明有很多,但终究是因为页面访问有问题。拦截器出问题的可能性最大。不同系统的拦截方法,可能不尽相同,在这块找问题,基本会解决。提供一点样例代码,仅供参考。

web.xml

1
2
3
4
<url-pattern>/swagger-resources/configuration/ui</url-pattern>
<url-pattern>/swagger-resources/configuration/security</url-pattern>
<url-pattern>/swagger-resources</url-pattern>
<url-pattern>/v2/api-docs</url-pattern>

拦截器Java类中

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
     * 登录校验忽略swagger
     
     * @param mapping
     *            相关映射
     * @return
     * @author Corpse
     * @since 2018-08-23 18:26
     */
    private boolean swagger(String mapping)
    {
        return swaggerAccess && XhString.equals(mapping,
                "/swagger-resources/configuration/ui",
                "/swagger-resources/configuration/security",
                "/swagger-resources",
                "/v2/api-docs");
    }

注意:根据自己系统的实际情况,合理配置拦截规则。

解决这两个问题之后,根据上面文档中的描述,就可以得到你想要的页面了。

【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

作者其他文章

评论(0

抱歉,系统识别当前为高风险访问,暂不支持该操作

    全部回复

    上滑加载中

    设置昵称

    在此一键设置昵称,即可参与社区互动!

    *长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

    *长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。