概览：

  • java集成Swagger
  • Swagger-UI的使用
  • Springboot跨域请求的访问解决

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。本文主要介绍了在 Spring Boot 添加 Swagger 支持， 生成可自动维护的 API 文档。

1 . POM文件概览：

<parent>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-parent</artifactId>

    <version>1.5.8.RELEASE</version>

    <relativePath/> <!-- lookup parent from repository -->

</parent>

<dependencies>

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-web</artifactId>

    </dependency>

	<dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-test</artifactId>

        <scope>test</scope>

    </dependency>

    <!--freemaker支持-->

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-freemarker</artifactId>

    </dependency>

    <!--添加swagger支持-->

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

        <version>2.6.1</version>

    </dependency>

    <dependency>

        <groupId>io.swagger</groupId>

        <artifactId>swagger-annotations</artifactId>

        <version>1.5.13</version>

    </dependency>

</dependencies>

2 . 在Application同目录下创建Swagger2的配置文件 Swagger2.java

@Configuration

@EnableSwagger2

public class Swagger2 {

    @Bean

    public Docket config() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .useDefaultResponseMessages(false)

                .select()

                .apis(RequestHandlerSelectors.basePackage("com.yl.swagger.controller"))

                .build();

    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                .title("这个标题")

                .contact(new Contact("yl", "47.95.196.183/esileme", "280885685@qq.com"))

                .build();

    }

}

.apis(RequestHandlerSelectors.basePackage("com.pxx.xxx.controller")) 指定了 Swagger 的扫描包名， 假如不指定此项， 在 Spring Boot 项目中， 会生成 base-err-controller 的 api 接口项。

配置好swagger后，在项目中访问 ip:prot/v2/api-docs 即可访问生成文档的json结构，如（http://localhost:8080/v2/api-docs）可以看到，会出现一大串Json字符串。

具体可参考Swagger官方示例。

3 . Swagger-UI配置

Swagger扫描解析得到的是一个json文档，对于用户不太友好。下面介绍swagger-ui，它能够友好的展示解析得到的接口说明内容。

从github 上获取其所有的 dist 目录下东西放到需要集成的项目里，本文放入 resource/static/swagger 目录下。

修改swagger/index.html文件，默认是从连接http://petstore.swagger.io/v2/swagger.json获取 API 的 JSON，这里需要将url值修改为http://{ip}:{port}/{projectName}/api-docs的形式，{}中的值根据自身情况填写，其实也就是步骤二中的json地址，我的是http://localhost:8080/v2/api-docs。

因为swagger-ui项目都是静态资源，restful形式的拦截方法会将静态资源进行拦截处理，所以要对springboot进行静态资源拦截的处理。

下一步，在代码中调用dist目录下的index.html文件，即可访问到接口文档说明了。

4 . springboot添加freemaker模板引擎

在默认的templates文件夹中新建welcome.ftl 内容如下:

	    <!DOCTYPE html>

	    <html>

	    	<body>

	    		Hello,${name}.欢迎阅读《${bookTitle}》

	    	</body>

	    </html>

创建一个controller hellocontroller

	@Controller

	@RequestMapping("/test")

	public class HelloController {

	    @RequestMapping("")

	    public Object test(ModelMap map) {

	        System.err.println("cnm");

	        map.put("name", "yl");

	        map.put("bookTitle", "bookTitle");

	        return "welcome";

	    }

	}

打开浏览器，访问http://localhost:8080/test 即可访问welcome页面。

  • 在访问index.html的时候，会提示跨域请求没有权限的问题，在Application中添加

      @Bean
    
  public CorsFilter corsFilter() {
    
  UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
    
  source.registerCorsConfiguration("/**", buildConfig());
    
  return new CorsFilter(source);
    
  }

  private CorsConfiguration buildConfig() {
    
  CorsConfiguration corsConfiguration = new CorsConfiguration();
    
  corsConfiguration.addAllowedOrigin("*");
    
  corsConfiguration.addAllowedHeader("*");
    
  corsConfiguration.addAllowedMethod("*");
    
  return corsConfiguration;
    
  }

即可。

备忘：

  • Swagger-UI本质上是一个写好的html静态页面，我们只需要将我们提供的接口写入index.html中，会给我们的接口数据渲染成一个html页面。
  • Swagger-UI会查找出所有写的请求地址，并显示出来,如我们定义了一个/test 接口，它会把这个接口给显示出来。

java集成swagger的更多相关文章

  1. Java高并发秒杀系统API之SSM框架集成swagger与AdminLTE

    初衷与整理描述 Java高并发秒杀系统API是来源于网上教程的一个Java项目,也是我接触Java的第一个项目.本来是一枚c#码农,公司计划部分业务转java,于是我利用业务时间自学Java才有了本文 ...

  2. 基于SpringMVC下的Rest服务框架搭建【1、集成Swagger】

    基于SpringMVC下的Rest服务框架搭建[1.集成Swagger] 1.需求背景 SpringMVC本身就可以开发出基于rest风格的服务,通过简单的配置,即可快速开发出一个可供客户端调用的re ...

  3. Spring Boot 集成 Swagger，生成接口文档就这么简单！

    之前的文章介绍了<推荐一款接口 API 设计神器!>,今天栈长给大家介绍下如何与优秀的 Spring Boot 框架进行集成,简直不能太简单. 你所需具备的基础 告诉你,Spring Bo ...

  4. MP实战系列(二)之集成swagger

    其实与spring+springmvc+mybatis集成swagger没什么区别,只是之前写的太不好了,所以这次决定详细写. 提到swagger不得不提rest,rest是一种架构风格,里面有对不同 ...

  5. Spring Boot 项目实战（三）集成 Swagger 及 JavaMelody

    一.前言 上篇介绍了 Logback 的集成过程,总体已经达到了基本可用的项目结构.本篇主要介绍两个常用工具,接口文档工具 Swagger .项目监控工具 JavaMelody 的集成步骤. 二.Sw ...

  6. Maven + SpringMVC项目集成Swagger

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

  7. 在spring+springMvc+mabatis框架下集成swagger

    我是在ssm框架下集成swagger的,具体的ssm搭建可以看这篇博文: Intellij Idea下搭建基于Spring+SpringMvc+MyBatis的WebApi接口架构 本项目的GitHu ...

  8. springboot快速集成swagger

    今天技术总监说:小明,我们本次3.0改造,使用swagger2.0作为前后端分离的接口规范,它可以一键生成前后端的API,一劳永逸--小明:??? Spring Boot 框架是目前非常流行的微服务框 ...

  9. 小白的springboot之路（二）、集成swagger

    0-前言 现在的项目开发,基本都是前后端分离,后端专注于API接口开发,都需要编写和维护API接口文档.如果你还在用Word来编写接口文档,那你就out了,这个时候,当当当当~神兵利器swagger隆 ...

随机推荐

  1. 【bfs】最少转弯问题

    题目描述 给出一张地图,这张地图被分为n×m(n,m<=100)个方块,任何一个方块不是平地就是高山.平地可以通过,高山则不能.现在你处在地图的(x1,y1)这块平地,问:你至少需要拐几个弯才能 ...

  2. ElasticSearch6.5.0 【Java客户端之REST Client】

    说明 High Level Client 是基于 Low Level Client 的.官方文档如下: * https://www.elastic.co/guide/en/elasticsearch/ ...

  3. 二、java基本语法

    一.标识符 java对各种变量.方法和类等要素命名时使用的字符序列成为标识符:通俗点,凡是自己可以起名字的地方都叫标识符,都遵守标识符的规则 1.标识符命名规则: 1)标识符由字符.下划线.美元符或数 ...

  4. Spotlight--你不得不用的Mac查询利器

    世界上有两种Mac用户:一种是经常使用Spotlight的,另一种是忽略Spotlight的.如果你是第二种用户,那么你需要改变.Mac所有方面的使用场景,都会随着Spotlight而变得更快.你只需 ...

  5. mysql加速导入数据的简单设置

    mysql加速导入数据的简单设置 # 修改前查询参数值 show variables like 'foreign_key_checks'; show variables like 'unique_ch ...

  6. Tensorflow基本语法

    一.tf.Variables() import tensorflow as tf Weights = tf.Variable(tf.random_uniform([1], -1.0, 1.0)) se ...

  7. 第二十节: 深入理解并发机制以及解决方案(锁机制、EF自有机制、队列模式等)

    一. 理解并发机制 1. 什么是并发,并发与多线程有什么关系? ①. 先从广义上来说,或者从实际场景上来说. 高并发通常是海量用户同时访问(比如:12306买票.淘宝的双十一抢购),如果把一个用户看做 ...

  8. day 18 - 1 正则与 re 模块

    正则表达式 官方定义:正则表达式是对字符串操作的一种逻辑公式,就是用事先定义好的一些特定字符.及这些特定字符的组合,组成一个 “规则字符串”,这个 “规则字符串” 用来表达对字符串的一种过滤逻辑. 我 ...

  9. Executors的四种线程池

    Executors.newCachedThreadPool(); Executors.newFixedThreadPool(2); Executors.newScheduledThreadPool(2 ...

  10. Linux 虚拟机上安装linux系统 (ip:子网掩码，网关,dns,交换机,路由知识回顾)

    一 安装虚拟机 二 虚拟机上配置好在安装linux系统 三 知识回顾 交换机:主机在局域网内的身份是MAC地址(可以通过[交换机广播:交换机通过被动学习来建立一张“接口号”和“MAC地址”的对照表]或 ...