Swagger技术(swagger2/swagger3/knife4j)

已于 2022-10-19 19:45:30 修改
阅读量9.4k 收藏 104
点赞数 10
分类专栏： # Java高级技术 默认归档 # 技巧合集 文章标签： Swagger swagger3 knife4j
于 2019-10-15 15:01:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43371556/article/details/102544252
版权

Swagger(接口文档实时动态生成工具

一、Swagger 简介

出现背景

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

Open API

Open API 规范(OpenAPI Specification)以前叫做Swagger 规范，是REST API 的API 描述格式。

Open API 文件允许描述整个API，包括：

  • 每个访问地址的类型。POST 或GET。
  • 每个操作的参数。包括输入输出参数。
  • 认证方法。
  • 连接信息，声明，使用团队和其他信息。

Open API 规范可以使用YAML 或JSON 格式进行编写。这样更利于我们和机器进行阅读。

OpenAPI 规范（OAS）为RESTful API 定义了一个与语言无关的标准接口，
允许人和计算机发现和理解服务的功能，而无需访问源代码，文档或通过网络流量检查。
正确定义后，消费者可以使用最少量的实现逻辑来理解远程服务并与之交互。
然后，文档生成工具可以使用OpenAPI 定义来显示API，
使用各种编程语言生成服务器和客户端的代码生成工具，测试工具以及许多其他用例。
Swagger官网
Swagger的官方文档

Swagger 简介

Swagger 是一套围绕Open API 规范构建的开源工具，
可以帮助设计，构建，记录和使用REST API。

Swagger 工具包括的组件：
Swagger Editor ：
基于浏览器编辑器，可以在里面编写Open API规范。类似Markdown 具有实时预览描述文件的功能。
Swagger UI：
将Open API 规范呈现为交互式API 文档。用可视化UI 展示描述文件。
Swagger Codegen：
将OpenAPI 规范生成为服务器存根和客户端库。
通过Swagger Codegen 将描述文件生成html 格式和cwiki 形式的接口文档，同时也可以生成多种言语的客户端和服务端代码。
Swagger Inspector：
和Swagger UI 有点类似，但是可以返回更多信息，也会保存请求的实际参数数据。
Swagger Hub：
集成了上面所有项目的各个功能，你可以以项目和版本为单位，将你的描述文件上传到Swagger Hub 中。
在SwaggerHub 中可以完成上面项目的所有工作，需要注册账号，分免费版和收费版。

使用Swagger，就是把相关的信息存储在它定义的描述文件里面（yml 或json 格式），
再通过维护这个描述文件可以去更新接口文档，以及生成各端代码.

二、Springfox

使用Swagger 时如果碰见版本更新或迭代时， 只需要更改Swagger 的描述文件即可。
但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件（yml 或json）也是一定的工作负担，久而久之就直接修改代码，而不去修改描述文件了，这样基于描述文件生成接口文档也失去了意义。

Marty Pitt 编写了一个基于Spring 的组件swagger-springmvc。
Spring-fox 就是根据这个组件发展而来的全新项目。
Spring-fox 是根据代码生成接口文档，所以正常的进行更新项目版本，修改代码即可，而不需要跟随修改描述文件。
Spring-fox 利用自身AOP 特性，把Swagger 集成进来，底层还是Swagger。但是使用起来确方便很多。
所以在实际开发中，都是直接使用spring-fox。

官网地址
官方源码

三、Swagger 用法

1.编写SpringBoot 项目

编写SpringBoot 项目，项目中controller 中包含一个Handler，
测试项目，保证程序可以正确运行。

可以使用自己经编写好的可以返回json的controller进行测试

@RestController
@RequestMapping("/emp/provider")
public class EmpController {
	
	@Autowired
	private EmpService empService;
	
	@GetMapping("/findAll")
	public PageInfo<Emp> findAll(@RequestParam(name="page",defaultValue="1") Integer page,
	@RequestParam(name="rows",defaultValue="1") Integer rows){
		
		return this.empService.findAll(page, rows);
	}
}

在这里插入图片描述

2 导入Spring-fox 依赖

在项目的pom.xml 中导入Spring-fox 依赖。目前最新版本为2.9.2，所以导入的依赖也是这个版本。
其中springfox-swagger2 是核心内容的封装。springfox-swagger-ui 是对swagger-ui 的封装。

<!-- 接口文档可以实时动态生成工具Swagger -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>
		<!-- 懒人必备开发测试工具 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<scope>runtime</scope>
			<optional>true</optional>
		</dependency>

3.启动类添加注解@EnableSwagger2

添加此注解后表示对当前项目中全部控制器进行扫描。

4.访问UI页面入http://ip:port/swagger-ui.html

在页面中可以通过可视化的进行操作项目中所有接口。
在这里插入图片描述

四、Swagger-UI 使用

访问swagger-ui.html 后可以在页面中看到所有需要生成接口文档的控制器名称。

在这里插入图片描述

每个控制器中间包含多所有控制器方法的各种访问方式。
如果使用的是@RequestMapping 进行映射，将显示所有请求方式。
如果使用@PostMapping 将只有Post 方式可以能访问，下面也就只显示Post 的一个。

点击某个Handle方法,点击try it out,即可对该方法进行测试(类似postman)
在这里插入图片描述

填写好参数后, 点击excute,然后显示相关信息
在这里插入图片描述

模型models, 显示该项目所有的模型信息, 特别是controller中方法的返回值(一般是实体类)的信息
在这里插入图片描述

五、Swagger 配置

可以在项目中创建SwaggerConfig，进行配置文档内容。

1 配置基本信息(下图)

Docket：摘要对象，通过对象配置描述文件的信息。
apiInfo:设置描述文件中info。参数类型ApiInfo
select():返回ApiSelectorBuilder 对象，通过对象调用build()可以创建Docket 对象

在这里插入图片描述
创建基本信息的配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * Swagger基本信息的配置
 * 
 * @author chy
 *
 */
@Configuration
public class SwaggerConfig {

	@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(swaggerApiInfo()).select().build();
	}

	private ApiInfo swaggerApiInfo() {
		return new ApiInfoBuilder()
				// 联系人信息 name url email
				.contact(new Contact("时间静止不是简史", "https://blog.csdn.net/qq_43371556", "xxx@qq.com"))
				// 文档标题
				.title("这里是Swagger 的标题")
				// 文档描述
				.description("这里是Swagger 的描述")
				// 文档版本
				.version("1.0.0").build();
	}

}

测试结果

在这里插入图片描述

2 设置扫描的包(类级别)

@Configuration
public class SwaggerConfig {

	@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(swaggerApiInfo())
				.select()
				//设置扫描的包
			    .apis(RequestHandlerSelectors.basePackage("ah.szxy.springcloud.provider.controller"))
				.build();
	}



	private ApiInfo swaggerApiInfo() {
		return new ApiInfoBuilder()
				// 联系人信息 name url email
				.contact(new Contact("时间静止不是简史", "https://blog.csdn.net/qq_43371556", "xxx@qq.com"))
				// 文档标题
				.title("这里是Swagger 的标题")
				// 文档描述
				.description("这里是Swagger 的描述")
				// 文档版本
				.version("1.0.0").build();
	}
	
	

}

测试,可以看到只有自定controller包下的controller类才会被扫描到
在这里插入图片描述

3 自定义注解设置不需要生成接口文档的方法(方法级别)

1)自定义注解(注解名称随意)
通过@注解名使用自定义注解

/**
 * 自定义注解设置
 * 定义后 @NotIncludeSwagger即可使用定义注解
 * @author chy
 *
 */
@Target({ElementType.METHOD})  //该注解在哪里生效
@Retention(RetentionPolicy.RUNTIME)  //注解使用策略:运行时
public @interface NotIncludeSwagger {
	
}

2)添加规则
通过public ApiSelectorBuilder apis(Predicateselector)可以设置生成规则。

 .apis(Predicates.not(RequestHandlerSelectors.withMethodAnnotation(NotIncludeSwagger.class)))

public static Predicate not(Predicate predicate) :表示不允许的条件。
withMethodAnnotation：表示此注解是方法级别注解。

@Configuration
public class SwaggerConfig {

	@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(swaggerApiInfo())
				.select()
				//设置扫描的包
			    .apis(RequestHandlerSelectors.basePackage("ah.szxy.springcloud.provider.controller"))
			    //自定义注解设置不需要生成接口文档的方法
	            .apis(Predicates.not(RequestHandlerSelectors.withMethodAnnotation(NotIncludeSwagger.class)))
				.build();
	}



	private ApiInfo swaggerApiInfo() {
		return new ApiInfoBuilder()
				// 联系人信息 name url email
				.contact(new Contact("时间静止不是简史", "https://blog.csdn.net/qq_43371556", "xxx@qq.com"))
				// 文档标题
				.title("这里是Swagger 的标题")
				// 文档描述
				.description("这里是Swagger 的描述")
				// 文档版本
				.version("1.0.0").build();
	}
	
	

}

注: Predicate可以定义的其他方法
在这里插入图片描述

3)添加自定义的NotIncludeSwagger 注解
在不需要生成接口文档的方法上面添加@NotIncludeSwagger 注解后，该方法将不会被Swagger 进行生成在接口文档中。

测试:添加该注解, 验证结果
在这里插入图片描述
在进行测试时,一定要注意清除浏览器缓存(或切换浏览器)!不然可能看不到效果哦~~~ 在这里插入图片描述

4 设置范围(url级别)

例子中表示只有以/test/开头的url 才能被swagger 生成接口文档。

@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(swaggerApiInfo())
				.select()
				//设置扫描的包
			    .apis(RequestHandlerSelectors.basePackage("ah.szxy.springcloud.provider.controller"))
			    //自定义注解设置不需要生成接口文档的方法
	            .apis(Predicates.not(RequestHandlerSelectors.withMethodAnnotation(NotIncludeSwagger.class)))
	            //设置生成接口文档的url规则  可以设置正则、ant表达式、全部、全都不
				.paths(Predicates.or(PathSelectors.regex("/test/.*")))
				.build();
	}

测试
复制一个用于测试Controller方法,更改url
在这里插入图片描述

在这里插入图片描述
可以看到只有以 /test/ 开头的EmpController2才会被显示
在这里插入图片描述
另外,该方法参数可以有多个:

如下方法是对 /test/ 开头的和以 /emp/开头的进行过滤

.paths(Predicates.or(PathSelectors.regex("/test/.*"),PathSelectors.regex("/emp/.*")))

如何希望全部扫描可以使用paths(PathSelectors.any())

	@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(swaggerDemoApiInfo())
				.select()
				.paths(allowPaths())
				.build();
	}

	private Predicate<String> allowPaths() {
		return or(regex("/demo/.*"));
	}

六、Swagger2 常用注解

1 Api(修改controller名与描述信息)

tags：类的名称。可以有多个值，多个值表示多个副本。
description:描述信息，已过时。

@Api(tags = {"mydemo"},description = "描述")

在这里插入图片描述

测试结果
可以看到Controller名和描述信息被修改(原来是Emp-controller)
在这里插入图片描述

2 ApiOperation(修改Handle的描述和详细信息)

value：接口描述
notes：详细提示信息

@ApiOperation(value="接口描述",notes = "接口详细提示信息")

在这里插入图片描述
测试
在这里插入图片描述

3 ApiParam(方法参数前)

@ApiParam 写在方法参数前面。用于对参数进行描述或说明是否为必添项等说明。
name：参数名称
value：参数描述
required：是否是必须

@ApiParam(name="page",value="当前页数",defaultValue="1",required = true)

注意:
在这里@ApiParam可以取代@RequestParam的作用,但是在value属性上有所不同
@RequestParam必须要和参数类型一致,而在@ApiParam的value指的的是描述信息
所以在二者同时使用时需要注意,或者干脆只使用一个
在这里插入图片描述
测试结果
在这里插入图片描述

4 ApiModel(类上)

@ApiModel 是类上注解，主要应用Model，也就是说这个注解一般都是写在实体类上。
value：名称
description：描述

@ApiModel(value = "人类",description = "描述")
public class People {

测试效果
在这里插入图片描述

5 ApiModelProperty(方法或属性)

@ApiModelProperty 可以用在 方法或属性 上。用于当对象作为参数时定义这个字段的内容。
value：描述
name：重写属性名
required：是否是必须的
example：示例内容
hidden：是否隐藏。

@ApiModelProperty(value = "姓名",name = "name",required = true,example = "张三")
private String name;

测试效果
在这里插入图片描述
在这里插入图片描述

6 ApiIgnore(类或方法或参数上)

@ApiIgnore 用于 方法或类或参数 上，表示这个方法或类被忽略。
和之前讲解的自定义注解@NotIncludeSwagger 效果类似。
只是这个注解是Swagger 内置的注解，而@NotIncludeSwagger 是我们自定义的注解。

7 ApiImplicitParam(方法上)

@ApiImplicitParam 用在方法上，表示单独的请求参数，总体功能和@ApiParam 类似。
name：属性名
value：描述
required：是否是必须的
paramType：属性类型
dataType：数据类型

@ApiImplicitParams(value={@ApiImplicitParam(name="id",value = "编号",
			required =true),@ApiImplicitParam(name="name",value = "姓名",required = true)})

在这里插入图片描述
在这里插入图片描述

截至2022.10.19, swagger已发布第三个大版本, 下面结合项目的集成来介绍其使用方法

七. swagger3

整合项目

  1. 添加坐标

    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

  2. 启动类中配置

    /**
 * 项目启动入口
 * @author Administrator
 */
@MapperScan(basePackages = "com.xxx.mapper")
@SpringBootApplication
@EnableScheduling
@EnableOpenApi
public class MisProjectApplication {

    public static void main(String[] args) {
        SpringApplication.run(MisProjectApplication.class, args);
    }
}

  3. 配置文件 application.properties 中手动声明swagger是否启动

    # swagger
swagger.enable=true

  4. 配置swagger 显示信息

    
import io.swagger.models.auth.In;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;
import java.util.List;

/**
 * info: swagger
 * 访问地址: http://localhost:23456/swagger-ui/index.html#/
 * @Author chy
 */
@Configuration
public class SwaggerConfig {

    @Value("${swagger.enable: true}")
    private boolean swaggerEnable;

    private String version = "1.0.0";

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("default")
                .apiInfo(apiInfo())
                .enable(swaggerEnable)
                .select()
                // 设置扫描路径
                .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目名")
                .description("项目描述")
                .contact(new Contact("负责人", "主页地址", "电子邮箱"))
                .version(version)
                .build();
    }
}

  5. 实体属性配置
    @ApiModel: 标注类
    @ApiModelProperty: 标注属性

    
@ApiModel(value="角色组")
public class RoleGroupPO implements Serializable {
    /**
     * 角色组id
     */
    @ApiModelProperty(value="角色组id")
    private Integer id;

    /**
     * 角色组名称
     */
    @ApiModelProperty(value="角色组名称", required = true)
    private String groupName;

    /**
     * 是否可操作(0: 不可操作, 1:可操作)
     */
    @ApiModelProperty(value="是否可操作(0: 不可操作, 1:可操作)", notes="角色组默认可操作, 除默认角色组除外")
}

  6. 控制器 Controller 配置
    @Api(tags = "角色权限-角色组接口"): 标注类
    @ApiOperation("新增角色组") : 标注方法
    @RequestBody: swagger提供, 作用同Spring自带的一样

    import io.swagger.v3.oas.annotations.parameters.RequestBody;

@RestController
@RequestMapping("")
@Api(tags = "角色权限-角色组接口")
public class RoleGroupController {

    @Resource
    private RoleGroupService roleGroupService;

    @ApiOperation("新增角色组")
    @PostMapping("/insert")
    private RpcServiceResult insert(@RequestBody  RoleGroupPO roleGroupPO) {
        int result = this.roleGroupService.insert(roleGroupPO);
        return RpcServiceResult.getSuccessResult(result);
    }
 }

  7. 访问地址 http://ip:port/mis/swagger-ui/index.html#/

拦截器放开swagger3访问

如果配置了拦截器 swagger所提供的的页面会被拦截, 因此需要在拦截器中放开swagger访问. 否则将无法访问. 具体操作步骤如下

  1. 拦截器配置类

    /**
 * Token 拦截器配置类
 * @Author chy
 */
@Configuration
public class FilterConfig implements WebMvcConfigurer {

    /**
     * token验证拦截器
     */
    @Autowired
    private TokenFilter tokenFilter;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // token验证拦截器
        registry.addInterceptor(tokenFilter)
                // 拦截的路径
                .addPathPatterns("/**")
                // 排除的路径
                .excludePathPatterns("/swagger**/**", "/webjars/**", "/v3/**", "/doc.html");
    }

 
}

  2. 无需配置或者根据自己业务情况配置

    import com.sxd.mis.service.LoginService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Token拦截器任务类
 * @Author chy
 */
@Component
@RequiredArgsConstructor
public class TokenFilter implements HandlerInterceptor {

    @Value(value = "${spring.profiles.active}")
    public String profiles = "";

    final LoginService loginService;

    /**
     * 登录接口uri
     */
    private static final String LOGIN_URL = "";
    /**
     * 免于token校验的环境
     */
    private static final String ACTIVE_DEV_PROFILE = "dev";
    /**
     * 测试时生产环境暂时放开
     */
    private static final String ACTIVE_TEST_PROFILE = "prod";
    /**
     * HTTP 中 存储token的key
     */
    public static final String HEADER_TOKEN_KEY = "Authorization";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  {
        //对登录接口进行放行
        if (LOGIN_URL.equals(request.getRequestURI())){
            return true;
        }
        if ("".equals(profiles) || ACTIVE_DEV_PROFILE.equals(profiles) || ACTIVE_TEST_PROFILE.equals(profiles)) {
        } else {
            loginService.checkToken(request.getHeader(HEADER_TOKEN_KEY));
        }
        return true;
    }


}

整合 knife4j

Knife4j是一个集Swagger 和 OpenAPI3为一体的增强解决方案
用于帮助开发者快速聚合使用OpenAPI规范. 官网地址
knife4j相当于是对swagger的json数据进行了封装. 以一种更美观的形式展现出来

整合步骤如下

  1. 添加注解

     <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>${knife4j-spring-boot-starter.version}</version>
  </dependency>

  2. 访问 http://ip:port/项目前缀(没有不写)/doc.html#/home
    在这里插入图片描述

  3. 查看接口文档
    在这里插入图片描述

  4. 进行接口调试
    在这里插入图片描述

总结

Swagger其实就是在管理Controller中的Handle所对应的接口,
由于管理后的描述文件是 json/yml格式不易观看, 所以引入了一个Swagger UI图形化管理页面
方便开发人员操作使用, 后端人员只需要引入Swagger和UI的坐标并在启动类添加@EnableSwagger2注解,
前端人员只需要访问 UI页面就可以实时的动态的知晓最新的接口信息, 减少人员沟通, 提升开发效率
通过使用相关注解, 可以方便我们快捷的对UI 页面的信息进行有解释的有选择的显示

在这里插入图片描述
描述信息(上图)
在这里插入图片描述
供所有开发人员访问的UI(上图)

演示代码源码
链接：https://pan.baidu.com/s/1jVL0oL5FrXuDxa8BGk5BVA
提取码：65fz
复制这段内容后打开百度网盘手机App，操作更方便哦

时间静止不是简史
关注
专栏目录
swagger技术
蚊子嗡嗡嗡的博客
01-10 234
swagger技术 一 swagger技术的作用： 可以用于测试请求，快速生成接口文档。 1.导包(2个依赖包) <!-- swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </d
Knife4j各版本集成SpringBoot 2.x 3.x版本demo示例
04-23
在本示例中，我们将探讨如何将Knife4j集成到Spring Boot 2.x和3.x版本中，以实现高效且美观的API文档生成。 首先，让我们了解Knife4j的基本概念。Knife4j是由xiaoymin开发的，它是Swagger UI的一个增强版，提供了更...
swagger技术分享ppt
05-08
swagger 技术分享ppt ..................................
Swagger技术
sxh06的博客
09-17 623
Swagger技术Swagger的作用与概念在项目中使用swagger配置swaggerApiInfo 配置swagger配置扫描接口配置api文档分组多个分组实体类配置 Swagger的作用与概念 Swagger官网，点此进入 在前后端分离时代，我们需要实时自动更新接口信息，和测试接口，实现前后端分离式开发，swagger因此产生 在项目中使用swagger 以下以3.0.0依赖为例 <!--swagger 相关组件--> <dependency>
Swagger
最新发布
weixin_63691530的博客
09-19 1225
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。使用Swagger，就是把相关的信息存储在它定义的描述文件里面（yml或json格式），再通过维护这个描述 文件可以去更新接口文档，以及生成各端代码。而Springfox-swagger,则可以通过扫描代码去生成这个 描述文件，连描述文件都不需要再去维护了。所有的信息，都在代码里面了。代码即接口文档，接口文 档即代码。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。
Swagger和knife4j_swagger_Swagger和knife4j_knife4jswagger_
09-30
Swagger 和 Knife4j 是两个广泛应用于 API 文档生成与管理的工具，主要服务于 RESTful 风格的 Web 服务。Swagger 提供了一种规范化的 JSON 格式（OpenAPI Specification）来描述 API，使得开发者可以自动生成 API ...
Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案
10-09
Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案。前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活。提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分。提供更多灵活的...
基于Java的knife4j与swagger-bootstrap-ui集成框架示例项目设计源码
04-11
本源码提供了一个基于Java的knife4j与swagger-bootstrap-ui集成框架示例项目设计。项目包含1445个文件，其中包括1110个Java源文件、71个XML文件、46个Gitignore文件、45个YAML文件、37个Markdown文档、30个JSON文件...
spring boot 集成swagger+knife4j，集成mybatis-plus和代码生成器
10-28
spring boot快速上手示例，集成了swagger+knife4j接口文档，集成mybatis-plus持久化，统一的数据返回封装，集成mybatis-plus-generator代码生成器，加入了lombok框架，一个完成的sping boot 示例项目，简单易上手
Spring Boot 整合Swagger2、Swagger3以及Knife4j
qq_43960768的博客
04-25 664
Spring Boot 整合Swagger2、Swagger3以及Knife4j
【技术】--swagger
lyn
11-05 650
dafad
swagger2 注解说明
KING_1314520的专栏
05-28 473
1、maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId&g..
Swagger相关技术栈
lonelymanontheway的博客
02-23 1678
Swagger Swagger-UI Swagger-codegen Swagger-editor Swagger-core Springfox Swagger2Markup
开发接口文档组件starter——swagger2
m0_52322439的博客
07-26 503
swagger2是在swagger基础上优化的一个更美观的接口文档，下面先简单介绍下swagger。 为了简化swagger的使用，Spring框架对swagger进行了整合，建立了Spring-swagger项目，后面改成了现在的Springfox。通过在项目中引入Springfox，可以扫描相关的代码，生成描述文件，进而生成与代码一致的接口文档和客户端代码。 swagger的常用注解： 注解 说明 @Api 用在请求的类上，例如Controller，表示对类的说明 @ApiMo
三分钟快速掌握Swagger入门技巧
weixin_41566126的博客
03-14 268
现在开发，很多采用前后端分离的模式，前端只负责调用接口，进行渲染，前端和后端的唯一联系，变成了API接口。因此，API文档变得越来越重要。swagger是一个方便我们更好的编写API文档的框架，而且swagger可以模拟http请求调用。 大部分采取的方式：Vue + SpringBoot，Vue通过js渲染页面，后端把数据传递给js，早期前端只负责写页面，然后把写好的HTML页面给后端，后端使用...
Swagger接口文档 —— 手把手教学，全方位超详细小白能看懂，百分百能用Java版
dream_ready的博客
04-18 5920
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。官网：https://swagger.io/是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
swagger工具编写接口文档
qq_60555957的博客
11-03 1165
swagger工具编写接口文档
Knife4j 4.0~4.1版本：Swagger2与OpenAPI3增强解决方案
资源摘要信息:"Knife4j是一个基于Swagger2和OpenAPI3的增强解决方案，旨在为开发者提供更加便捷的API文档管理和接口测试工具。从4.0版本到4.1版本，Knife4j在以下几个方面进行了显著提升和扩展。 1. 兼容性： - ...
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

时间静止不是简史

感谢你的肯定, 我将继续努力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值