springfox

一、POM添加 在pom文件里添加包 1 <!-- 引入knife4j以来 --> 2 < dependency > 3 < groupId > com.github.xiaoymin </ groupId > 4 < artifactId > knife4j-spring-boot-starter </ artifactId > < version > 1.9.6 </ version > 5 </ dependency > View Code 二、配置添加，相当于<bean>添加 1 package com.mrliu.undertow.conf; 2 3 import com.github.xiaoymin.knife4j.spring.annotations.EnableSwaggerBootstrapUi; 4 import org.springframework.context.annotation.Bean; 5 import org.springframework.context.annotation.Configuration; 6 import springfox.documentation.builders.ApiInfoBuilder; 7 import springfox.documentation.builders.PathSelectors; 8

最近 SpringFox 3.0.0 发布了，距离上一次大版本2.9.2足足有2年多时间了。可能看到这个名字，很多读者会有点陌生。但是，只要给大家看一下这两个依赖，你就知道了！ <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> <scope>compile</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> <scope>compile</scope> </dependency> 当我们在使用Spring MVC写接口的时候，为了生成API文档，为了方便整合Swagger，都是用这个SpringFox的这套封装。但是，自从2.9.2版本更新之后，就一直没有什么动静，也没有更上Spring Boot的大潮流，有一段时间还一直都是写个配置类来为项目添加文档配置的。为此，之前就造了这么个轮子： https://github.com/SpringForAll/spring-boot

一、Swagger 1、什么是 Swagger ？ 　　Swagger 是一个规范和完整的框架，用于生成、描述、调用以及可视化的 Restful 风格的 Web 服务。 　　简单的理解：是一款 REST API 文档生成工具，生成在线的接口文档，方便接口测试。 2、为什么使用 Swagger？ 　　前后端分离开发时，为了方便前后端接口调用规范，需要提供一个接口文档，但是维护这个接口文档是一个及其繁琐的事情，可能一不小心就忘记更新该文档从而导致前后端接口调用失败。 　　Swagger 就是为了解决这个问题而出现的（在线接口文档），其在接口方法上定义注解，并根据注解形成一个 html 页面，每次接口修改，这个 html 页面就会发生相应的改变，从而保证了接口文档的正确性。通过该 html 页面，可以很方便、清楚的知道这个接口的功能，并测试。 3、SpringBoot 整合 Swagger？ （1）Step1： 　　导入依赖 jar 包。 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger2 </ artifactId

1、搭建测试环境 步骤一：创建 maven 项目 父项目的pom文件 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.tqylxuecheng</groupId> <artifactId>xc_parent</artifactId> <packaging>pom</packaging> <version>1.0-SNAPSHOT</version> <modules> <module>xc_test_parent</module> </modules> <!-- 1 确定spring boot的版本--> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot

前言 　　Spring Boot 框架是目前非常流行的微服务框架，我们很多情况下使用它来提供 Rest API。而对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证 API 文档的及时性将有很大的帮助。本文将使用 Swagger 2 规范的 Springfox 实现来了解如何在 Spring Boot 项目中使用 Swagger，主要包含了如何使用 Swagger 自动生成文档、使用 Swagger 文档以及 Swagger 相关的一些高级配置和注解。 Swagger 简介 Swagger 是一套基于 OpenAPI 规范构建的开源工具，可以帮助我们设计、构建、记录以及使用 Rest API。Swagger 主要包含了以下三个部分： Swagger Editor：基于浏览器的编辑器，我们可以使用它编写我们 OpenAPI 规范。 Swagger UI：它会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档，后文我将使用浏览器来查看并且操作我们的 Rest API。 Swagger Codegen：它可以通过为 OpenAPI（以前称为 Swagger）规范定义的任何 API 生成服务器存根和客户端 SDK 来简化构建过程。 为什么要使用 Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。 作用： 接口的文档在线自动生成。 功能测试。 配置 第一步：配置pom.xml <dependencies> ... <!-- swagger www.1b23.com --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> <!-- swagger-ui www.1b23.com --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> </dependency> </dependencies> 第二步：IDEA执行Reimport All Maven Projects 第三步：使用注解来进行启动swagger package com.template.swagger; import springfox.documentation

> 接上篇《Apache Shiro 接管Swagger认证授权》，有热心网友反应Apache Shiro似乎太简单。针对这个问题，个人不做任何评价（一切技术服务于需求）。今天主要分享内容为：在Spring Security下如何接管Swagger的认证授权工作。 1.添加依赖 假定你对Swagger和Spring Security已经有一定的基础，现在开始检查你的项目中是否添加了Swagger和Spring Security的依赖。以Maven为例，向pom.xml文件添加如下配置信息： <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-security</artifactid> </dependency> <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

springboot 在集成swagger中会不会遇到各种问题： 1、swagger 进行接口鉴权（比如设置header的token，接口进行拦截处理）。 2、swagger 进行实体属性解析（pojo类的属性注解无法解析）。 3、swagger 进行响应码统一（code状态吗标识、200响应成功，响应体解析）。 4、swagger 设置接口共用参数（统一每个接口都存在的参数）。 以下是解决问题配置信息 一、引入依赖包 使用之前请更新或直接引用该版本依赖包 更新版本地址：接口依赖jar https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 ui 依赖jar https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger2 </ artifactId > < version > 2.9.2 </ version > </ dependency > < dependency > < groupId > io.springfox </ groupId > <

1、引入swagger的jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> <exclusions> <exclusion> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>1.6.1</version> </dependency> 注：这里重新引入swagger-models-1.6.1版本，是因为springfox-swagger2-2.9.2版本引入的swagger-models版本较低