分类：swagger

2021
10-29

SpringBoot中使用Swagger的超简单方法

Swagger号称世界上最流行的Api框架,它是RestFul风格的Api。文档在线自动生成工具：Api文档与API定义同步更新。可以直接运行，能在线测试API接口；支持多种编程语言：（Java、PHP等）。官网：https://swagger.io/springBoot使用swagger太麻烦，每次都需要编写config？如果我告诉你有这么一种方式，你只需要配置yml文件，你学还是不学？整合Swagger依赖：<!--Swagger--><dependency><groupId>com.battcn</groupId><artifa... 继续阅读 >

2021
10-25

springboot中swagger、异步/定时/邮件任务的问题

目录1、SpringBoot：集成Swagger终极版1.1、Swagger简介1.2、SpringBoot集成Swagger1.3、配置Swagger1.4、配置扫描接口1.5、配置Swagger开关1.6、配置API分组1.7、实体配置1.8、常用注解1.9、拓展：其他皮肤2、SpringBoot：异步、定时、邮件任务2.1、异步任务2.2、邮件任务2.3、定时任务1、SpringBoot：集成Swagger终极版学习目标：了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档1.1、Swagger简介前后端... 继续阅读 >

2021
09-20

Swagger屏蔽某些接口显示的操作

Swagger屏蔽某些接口显示首先说下为什么要屏蔽，因为某些接口是针对内部服务调用的，不需要进行对接。显示出来的话：1、容易混淆2、容易暴露相关接口内容其实屏蔽的话比较简单，主要是注解：@ApiIgnore@RequestMapping("/wx/back")@ApiIgnorepublicStringwxBack(HttpServletRequestrequest){returnpayService.back(ParamUtil.getXmlString(request),"zjcOrderService");}这样在Swagger上面就不会显示... 继续阅读 >

2021
06-23

在SpringBoot项目中的使用Swagger的方法示例

一.首先Swagger是什么?Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger官方API文档:https://swagger.io/作用：  1.接口的文档在线自动生成。  2.功能测试。Swagger的主见介绍:   Swagger... 继续阅读 >

2021
06-13

SpringBoot中swagger的使用

接口文档对前后端开发人员非常重要，swagger是基于openapi规范构建开源工具，swagger组件有swaggereditor基于浏览器编辑器，swaggerui可视化ui展示描述文件，swaggerinspector和ui组件很像，可以返回更多信息，会保存请求实际参数，springfox是可以根据代码生成接口文档，所以描述文件是根据项目来变化的，不用手动更新，springboot导入spring-fox依赖就是导入了wagger,在启动类上添加@EnableSwagger2注解，添加这... 继续阅读 >

2021
02-21

手把手教你SpringBoot快速集成Swagger的配置过程

导语相信大家无论是做前端还是做后端的，都被接口接口文档所折磨过，前端抱怨接口文档和后端给的不一致，后端抱怨写接口文档很麻烦，所以Swagger就诞生了。直接配置即可自动生成接口文档，而且提供了高效的API测试话不多说直接开干导入SpringBoot集成Swagger所需要的依赖<!--web方便测试--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></depen... 继续阅读 >

2021
01-09

swagger添加权限验证保证API（接口）安全性(两种方法)

当我们使用swagger，进行接口测试，怕接口不安全，担心暴露。可采用两种方式1.环境权限配置对swagger文档配置只在测试环境可访问，生产环境不可访问。@Profile({"dev","test"})如以上配置，则只有在dev以及test环境有效，在生产环境不可访问。2.账户权限配置在1.9.0版本时,针对Swagger的资源接口,SwaggerBootstrapUi提供了简单的Basic认证功能。如果是springboot项目可在yml文件配置2.1：配置yml文件swagger:production:falseba... 继续阅读 >

2020
11-11

ASP.NetCore使用Swagger实战

踩坑不背锅，.NETCore试深浅关于Swagger什么是swagger所带来的帮助使用Swagger关于Swagger什么是swagger使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。Swagger™的目标是为RESTAPIs定义一个标准的，与语言无关的接口。只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语... 继续阅读 >

2020
11-10

Spring Cloud Zuul集成Swagger实现过程解析

SpringCloudZuul集成Swagger1.准备服务注册中心eureka-server2.创建微服务swagger-service-astep1.创建微服务swagger-service-a(SpringBoot项目)，添加eureka-client起步依赖，web起步依赖和swagger依赖<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><a... 继续阅读 >

2020
10-28

Spring Boot 使用 Swagger 构建 RestAPI 接口文档

源码地址：https://github.com/laolunsi/spring-boot-examples目前SpringBoot常被用于开发JavaWeb应用，特别是前后端分离项目。为方便前后端开发人员进行沟通，我们在SpringBoot引入了Swagger。Swagger作用于接口，让接口数据可视化，尤其适用于RestfulAPi本节分两部分介绍，第一部分是SpringBoot引入Swagger的两种方式，第二部分是详细介绍在Web接口上应用Swagger的注解。本篇文章使用SpringBoot2.1.10.RELEASE和springfox-swa... 继续阅读 >

2020
10-10

基于swagger测试List类型参数过程详解

使用swagger时，往往会用到类似下面这样的注解@ApiImplicitParam(name="id",value="主键",dataType="int",paramType="query")网上说这里的dataType类型有String/int两种，其余的都是无用的。但是如果需要传递的参数是List类型，应该怎么办?首先直接在浏览器中输入网址，传递参数（xxx?idList=1,2,3）来测试，是没有问题的在swagger中如果直接使用int，List<Integer>这样的参数，会导致swagger无法测试接口... 继续阅读 >

2020
10-09

spring boot-2.1.16整合swagger-2.9.2 含yml配置文件的代码详解

java代码packagecom.oauth.util;importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importspringfox.documentation.builders.ApiInfoBuilder;importspringfox.documentation.builders.PathSelectors;importspringfox.documentation.builders.RequestHandlerSelectors;import... 继续阅读 >

2020
10-08

Spring Boot整合swagger使用教程详解

Swagger的介绍🔶你可能尝试过写完一个接口后，自己去创建接口文档，或者修改接口后修改接口文档。多了之后，你肯定会发生一个操作，那就是忘记了修改文档或者创建文档（除非你们公司把接口文档和写接口要求得很紧密😓忘记写文档就扣工资？，否则两个分离的工作总是有可能遗漏的）。而swagger就是一个在你写接口的时候自动帮你生成接口文档的东西，只要你遵循它的规范并写一些接口的说明注解即可。优点与缺点🔶... 继续阅读 >

2020
10-08

Django REST Swagger实现指定api参数

为什么要指定swagger的api参数api的参数有多种类型：query参数，如/users?role=adminpath参数，如/users/{id}header参数，如X-MyHeader:Valuebody参数，描述POST，PUT，PATCH请求的bodyform参数，描述Content-Typeofapplication/x-www-form-urlencoded和multipart/form-data的请求报文body的参数swagger指定api参数就可以在文档相应的api条目中显示出api的描述、正常输出、异常输出、参数的名称、描述、是否必... 继续阅读 >

2020
09-29

SpringBoot整合Swagger框架过程解析

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger让部署管理和使用功能强大的API从未如此简单。引入maven依赖<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2--><dependency><groupId>io.springfo... 继续阅读 >