Loading [MathJax]/jax/input/TeX/config.js

开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

社区首页 >专栏 >配置不同环境下启用swagger，在生产环境关闭swagger

配置不同环境下启用swagger，在生产环境关闭swagger

Ryan-Miao

发布于 2018-03-14 02:41:34

发布于 2018-03-14 02:41:34

2.8K00

代码可运行

举报

文章被收录于专栏：Ryan MiaoRyan Miao

运行总次数：0

代码可运行

前言

Swagger使用起来简单方便，几乎所有的API接口文档都采用swagger了。使用示例：http://www.cnblogs.com/woshimrf/p/swagger.html，现在开发中可以参考文档，但生产环境并不想暴露出去。

配置

只要在不同环境中配置是否启用就可以了。

@Value("${swagger.enable}")
private boolean enableSwagger;

@Bean 
public Docket customImplementation(){
    return new Docket(SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(enableSwagger) //<--- Flag to enable or disable possibly loaded using a property file
        .includePatterns(".*pet.*");
}

然后，我想在dev和test环境中启用，直接在配置文件中添加配置：

swagger:
  enable: true

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

评论

登录后参与评论

暂无评论

编辑精选文章

换一批

万字详解高可用架构设计

Go 开发者必备：Protocol Buffers 入门指南

10分钟带你彻底搞懂分布式链路跟踪

多租户的 4 种常用方案

亿级月活的社交 APP，陌陌如何做到 3 分钟定位故障？

60页PPT全解：DeepSeek系列论文技术要点整理

Sprngboot配置Swagger接口文档

2023腾讯·技术创作特训营第二期

小明今天要跟前端同学对接，发现接口，都是直接同个微信或者qq发给他，效率很低，而且前端同学也不能测试调用，在对接过程很麻烦，也很费时，他现在很苦恼，大家有什么好的接口文档工具推荐了。

小明爱吃火锅

2023/09/25

4900

在线问题反馈模块实战(七):安装部署swagger2

部署接口接口文档配置注解

接下来的这几期，bug菌想跟大家分享一下自己昨天刚接到一个临时的需求，热乎着呢，想分享一下自己是如何面对临时需求并制定整个开发周期，其中包括从梳理业务到创建业务表再到实现业务逻辑形成闭环再到与前端对接，其中会穿插一些业务拓展及功能性拓展，这一条龙流程在线与大家一起见证，分享给刚入门的小伙伴，希望对你们有所帮助。

bug菌

2023/05/27

4180

在线问题反馈模块实战(七):安装部署swagger2

Swagger2在生产环境禁用

后端接口文档配置前后端分离注解

Swagger 用来在开发阶段方便前后端分离的项目实战中，提高前后端人员的工作效率，降低交流成本。但是版本上线之后，要是把 Swagger 带上去会存在很大的风险。

Jensen_97

2023/07/20

1.6K0

SpirngBoot整合Swagger

spring api spring boot java 网站

由于Spring Boot能够快速开发、便捷部署等特性，相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因，这些终端会共用很多底层业务逻辑，因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。

框架师

2021/03/05

1.2K0

一文搞懂Swagger,让你明白用了Swagger的好处!!!

api spring 腾讯云测试服务网站 java

前后端分离缺陷了解Swagger之前,需要先知道什么是前后端分离现在的时代 SpringBoot + VUE 以前的时代 SSM + JSP模板引擎====>后端程序员前后端分离时代通过相关的

框架师

2020/06/16

4.4K2

Swagger技术概述

api code controller swagger 接口文档

Swagger出现的原因，很大程度上是由于前后端开发人员对于接口文档，无法做到高效的同步。前端人员苦于接口文档老旧，更新不及时，后端人员苦于在任务外另外维护接口文档。故而随着项目开发时间的推移，就导致项目的接口文档老旧，使用性差等问题暴露出来。

Ywrby

2022/10/27

3220

SpringBoot 在生产快速禁用Swagger2

spring http java html

0.6 2018.07.21 19:31* 字数 219 阅读 4858评论 11喜欢 52

用户1212940

2022/04/13

2.1K0

SpringBoot 在生产快速禁用Swagger2

spring boot集成swagger构建API文档

java https 网络安全 api

使用swagger不用手工写API相关的word文档了，并且还可以使用swagger生成的API文档进行测试，使用起来倍儿爽。接下来咱们就来搞一个demo案例。

田维常

2019/07/16

6510

spring boot集成swagger构建API文档

spring boot 下swagger2 的使用

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

acc8226

2022/05/17

6630

spring boot 下swagger2 的使用

【Spring Boot】018-Swagger

boot swagger 配置注解 spring

前端伪造后端数据——json，在写前端页面的时候已经存在，不需要后端，前端工程依旧能够跑起来；

訾博ZiBo

2025/01/06

400

【Spring Boot】018-Swagger

Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据

在当下这个前后端分离的技术趋势下，前端工程师过度依赖后端工程师的接口和数据，给开发带来了两大问题：

磊哥

2018/11/22

3.5K0

Spring Boot 自定义 Swagger2 请求 URL 路径的两种方法

java html http 网站

在这里，以 Spring Boot 项目为例，给出两种自定义 Swagger2 请求 URL 路径的方法。

CG国斌

2021/12/07

14.2K0

Spring Boot 自定义 Swagger2 请求 URL 路径的两种方法

Spring Boot：整合Swagger文档

spring-boot作为当前最为流行的Java web开发脚手架，越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端（b/s），也会服务于移动端。在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。

朝雨忆轻尘

2019/06/19

9210

Spring Boot：整合Swagger文档

Swagger技术(swagger2/swagger3/knife4j)

api java 编程算法 openapi spring

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范，不及时更新。当时自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。如果接口文档可以实时动态生成就不会出现上面问题。 Swagger 可以完美的解决上面的问题。

时间静止不是简史

2022/12/02

2.4K0

Swagger技术(swagger2/swagger3/knife4j)

前端嫌弃原生Swagger界面太low，于是我给她开通了超级VIP

java spring boot

接口文档想必是许多开发小伙伴的噩梦，不仅要写详细，还要及时维护文档与后端代码保持一致，稍有没及时更新接口文档，前端同学肯定会抱怨后端同学给的文档与实际情况不一致。

陈皮的JavaLib

2021/03/28

6880

前端嫌弃原生Swagger界面太low，于是我给她开通了超级VIP

Spring Boot从入门到精通-集成swagger

这一步完成之后，启动项目，打开 localhost:8080/swagger-ui.html#/就可以看到swagger的界面了，并且我们写好的那个接口也已经躺在那里等我们的调用。 swagger还有更多的注解帮助我们完善接口文档。

我的小熊不见了丶

2019/05/22

5930

一文搞懂Swagger,让你明白用了Swagger的好处!!!

java api spring 网站 json

前后端分离缺陷了解Swagger之前,需要先知道什么是前后端分离现在的时代 SpringBoot + VUE..........等等以前的时代 SSM + JSP模板引擎====>后端程序员前

框架师

2020/06/11

6K0

SpringBoot 通过配置禁用swagger

使用注解@Profile({“dev”,“test”}) 表示在开发或测试环境开启，而在生产关闭。（推荐使用）

用户1212940

2022/04/13

2K0

SpringBoot整合Swagger 自动生成在线API文档偷懒必备同时也是我们的基本操作啦！！！

java 腾讯云测试服务 api

现在小伙伴学习SpringBoot大都数是前后端开发的，这个API接口文档真的不可缺少的一部分。

宁在春

2022/10/31

3810

SpringBoot整合Swagger 自动生成在线API文档偷懒必备同时也是我们的基本操作啦！！！

Swagger Api工具

java api 腾讯云测试服务网站

Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale.

暴躁的程序猿

2022/03/24

5700

相关推荐

Sprngboot配置Swagger接口文档

更多 >

LV.1

深圳顺丰科技Java dev

作者相关精选

使用swagger作为restful api的doc文档生成

目录

前言

配置

加入讨论

的问答专区 >

相关课程

一站式学习中心 >

AI绘画-StableDiffusion图像生成

大模型图像创作引擎

高性能应用服务

微信小程序学习路径课

云开发 CloudBase

小程序·云开发

微信小程序

本文部分代码块支持一键运行，欢迎体验

本文部分代码块支持一键运行，欢迎体验