概览：

  • 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. java并发编程实践——王宝令(极客时间)学习笔记

    1.并发 分工:如何高效地拆解任务并分配给线程 同步:线程之间如何协作 互斥:保证同一时刻只允许一个线程访问共享资源 Fork/Join 框架就是一种分工模式,CountDownLatch 就是一种典 ...

  2. DZY Loves Math 系列详细题解

    BZOJ 3309: DZY Loves Math I 题意 \(f(n)\) 为 \(n\) 幂指数的最大值. \[ \sum_{i = 1}^{a} \sum_{j = 1}^{b} f(\gcd ...

  3. Git让你从入门到精通，看这一篇就够了

    简介 Git 是什么? Git 是一个开源的分布式版本控制系统. 什么是版本控制? 版本控制是一种记录一个或若干文件内容变化,以便将来查阅特定版本修订情况的系统. 什么是分布式版本控制系统? 介绍分布 ...

  4. vsftp配置文件详解

    匿名用户相关参数 anonymous_enable=YES # 是否允许匿名用户登陆 no_anon_password=NO # 是否忽略对匿名用户的密码检测 anon_root # 匿名登陆后尝试更 ...

  5. <Android基础>(三) UI开发 Part 3 RecyclerView

    RecyclerView 1)RecyclerView的基本用法 2)横向滚动和瀑布流滚动 3)注册点击事件 3.6 强大的滚动控件 RecyclerView ListView缺点: 1.不使用技巧优 ...

  6. 洛谷P3205 [HNOI2011]合唱队 DP

    原题链接点这里 今天在课上听到了这个题,听完后觉得对于一道\(DP\)题目来说,好的状态定义就意味着一切啊! 来看题: 题目描述 为了在即将到来的晚会上有更好的演出效果,作为AAA合唱队负责人的小A需 ...

  7. cacti报警邮件的设置

    众所周知,用Linux系统自带的sendmail发送邮件是有限制的,可能对有些邮箱无法正常发送,导致报警邮件不能够及时发送到,因此就可能会产生不必要的麻烦!对此,我们可以用其他方法来发送邮件,就是在c ...

  8. MySQL5.7.23解压版安装教程

    每次找安装教程太麻烦,因此给自己备份一下步骤,方便以后查看.解压版下载地址https://dev.mysql.com/downloads/mysql/,详细图解如下: 1.根据自己需求,选择适合自己的 ...

  9. springmvc 项目单元测试

    对于web项目如果希望通过url来进行单元测试,但是启动服务器和建立http client 来进行测试非常麻烦,并且依赖网络环境.这样我们可以通过引入MockMvc进行测试. 一.引入jar包 < ...

  10. Entity Framework入门教程（3)---EF中的上下文简介

    1.DbContext(上下文类) 在DbFirst模式中,我们添加一个EDM(Entity Data Model)后会自动生成一个.edmx文件,这个文件中包含一个继承DbContext类的上下文实 ...