资讯专栏INFORMATION COLUMN

Spring Swagger在nginx 二级url 无法正常使用 修改host解决

xingqiba / 610人阅读

摘要:解决方法在配置直接设置的就可以了,网上搜索一堆完全没找到这个问题的解决方案,最后翻了源码找到方法。二级配置类接口文档接口文档

问题描述
测试环境用了nginx做二级url做映射,但swagger的http://www.xxx.com/二级url/v2...
JSON里面的host地址还是一级目录,不自动对应nginx做了映射的二级url,因此使用swagger-ui.html在线调试API接口,就出问题,请求不到服务报404。
解决方法

在配置直接设置Docke的host就可以了,网上搜索一堆完全没找到这个问题的解决方案,最后翻了源码找到host()方法。


application.yml

swagger:
  host: www.xxx.com/二级url

Swagger配置类

@Configuration
public class SwaggerConfig {

    @Value("${swagger.host}")
    private String swaggerHost;

    @Bean
    public Docket customDocket() {

        Docket docket=new Docket(DocumentationType.SWAGGER_2);
        if(StringUtils.isNotBlank(swaggerHost)){
            docket=docket.host(swaggerHost);
        }
        docket=docket.apiInfo(apiInfo())
                .useDefaultResponseMessages(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx.web"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API接口文档")
                .description("API接口文档")
                .contact(new Contact("xx", "http:/xxx.com", "xxxx@qq.com"))
                .version("1.0")
                .build();
    }

}

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/39959.html

相关文章

  • 基于 Nginx 的动态代理

    摘要:目前最常用的软件反向代理服务器有和。基于实现动态代理为了实现动态代理方案,需要在反向代理服务器中增加定制的功能。同时,由于反向代理服务器需要处理大量的代理请求,因此会频繁的读取反向代理配置数据。 基于 Nginx 的动态代理 作者:赵波日期:2016 年 8 月 4 日 在实际应用中,遇到了这样一个场景: 已有一个手机 APP 客户端,需要在该 APP 客户端中实现通过 Web 的形式...

    wean 评论0 收藏0
  • 【效率专精系列】善用API统一描述语言提升RestAPI开发效率

    摘要:其标准为前身是,提供强大的在线编辑功能,包括语法高亮错误提示自动完成实时预览,并且支持用户以格式撰写导入导出转换文档。 团队内部RestAPI开发采用设计驱动开发的模式,即使用API设计文档解耦前端和后端的开发过程,双方只在联调与测试时耦合。在实际开发和与前端合作的过程中,受限于众多因素的影响,开发效率还有进一步提高的空间。本文的目的是优化工具链支持,减少一部分重复和枯燥的劳动。 现状...

    tianyu 评论0 收藏0
  • Gradle环境下导出Swagger为PDF

    摘要:没错,不支持,从导出的文档也可以看到,部分中文无法显示,目前我也尚未找到是否有配置可以实现这个功能。相对前面的方式,使用起来更加简单,也可以修改配置输出中文。 更多精彩博文,欢迎访问我的个人博客 说明 我个人是一直使用Swagger作为接口文档的说明的。但是由于在一些情况下,接口文档说明需要以文件的形式交付出去,如果再重新写一份文档难免有些麻烦。于是在网上看到了Swagger2Mar...

    OnlyMyRailgun 评论0 收藏0

发表评论

0条评论

xingqiba

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<