脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Cloud Zuul

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

 更新时间：2020年11月09日 09:51:40   作者：dreamstar  
这篇文章主要介绍了Spring Cloud Zuul集成Swagger实现过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

Spring Cloud Zuul 集成Swagger

1.准备服务注册中心eureka-server

2.创建微服务swagger-service-a

step1. 创建微服务swagger-service-a(Spring Boot项目)，添加eureka-client起步依赖，web起步依赖 和swagger依赖

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <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>

step2.在配置类添加注解@EnableDiscoveryClient ，，将当前应用 添加到 服务治理体系中，开启微服务注册与发现。

step3.配置swagger

package com.example.swaggerservicea;
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.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket api() {

    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any()).build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("swagger-service-a 实例文档")
        .description("swagger-service-a 实例文档 1.0")
        .termsOfServiceUrl("https:github")
        .version("1.0")
        .build();
  }

}

step4.application.properties文件中添加配置

#微服务基本信息
spring.application.name=swagger-service-a
server.port=10010
#注册中心
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
#要生成文档的package
swagger.base-package=com.example

step5.添加一个微服务提供的功能

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AaaController {
  @Autowired
  DiscoveryClient discoveryClient;

  @GetMapping("/service-a")
  public String dc() {
    String services = "service-a Services: " + discoveryClient.getServices();
    System.out.println(services);
    return services;
  }
}

step6.启动微服务，访问 http://localhost:10010/swagger-ui.html

3.创建微服务swagger-service-b （参考swagger-service-a ）， 启动微服务swagger-service-b并访问http://localhost:10020/swagger-ui.html

4.构建API网关并整合Swagger

step1.创建API网关微服务swagger-api-gateway，添加eureka-client起步依赖，zuul起步依赖 和 swagger依赖 :spring-cloud-starter-netflix-eureka-client，spring-cloud-starter-netflix-zuul

<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <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>

step2.在配置类添加注解@SpringCloudApplication ，@EnableZuulProxy

step3.配置swagger

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.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket api() {

    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any()).build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("swagger-service 实例文档")
        .description("swagger-service 实例文档 1.0")
        .termsOfServiceUrl("https:github")
        .version("1.0")
        .build();
  }

}

step4.配置swagger

package com.example.swaggerapigateway;

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

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;

@Component
@Primary
class DocumentationConfig implements SwaggerResourcesProvider {
  @Override
  public List<SwaggerResource> get() {
    List resources = new ArrayList<>();
    resources.add(swaggerResource("service-a", "/swagger-service-a/v2/api-docs", "2.0"));
    resources.add(swaggerResource("service-b", "/swagger-service-b/v2/api-docs", "2.0"));
    return resources;
  }

  private SwaggerResource swaggerResource(String name, String location, String version) {
    SwaggerResource swaggerResource = new SwaggerResource();
    swaggerResource.setName(name);
    swaggerResource.setLocation(location);
    swaggerResource.setSwaggerVersion(version);
    return swaggerResource;
  }
}

step5.application.properties文件中添加配置

#微服务基本信息
spring.application.name=swagger-api-gateway
server.port=10030
#注册中心
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
#要生成文档的package
swagger.base-package=com.example

step6.启动微服务，访问http://localhost:10030/swagger-ui.html

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Java使用正则表达式判断字符串是否以字符开始

    Java使用正则表达式判断字符串是否以字符开始

    这篇文章主要介绍了Java使用正则表达式判断字符串是否以字符开始的相关资料,需要的朋友可以参考下
    2017-06-06
  • Mybatis逆工程的使用

    Mybatis逆工程的使用

    最近在学Mybatis，类似Hibernate，Mybatis也有逆工程可以直接生成代码(mapping,xml,pojo)，方便快速开发。这篇文章给大家介绍Mybatis逆工程的使用相关知识，感兴趣的朋友一起看下吧
    2016-06-06
  • 浅谈java中的重载和重写的区别

    浅谈java中的重载和重写的区别

    本文主要介绍了java中的重载和重写的区别。具有一定的参考价值，下面跟着小编一起来看下吧，希望能够给你带来帮助
    2021-11-11
  • Java多线程:生产者与消费者案例

    Java多线程:生产者与消费者案例

    这篇文章主要介绍了Java并发编程中的生产者与消费者模型简述,多线程并发是Java编程中最终要的部分之一,需要的朋友可以参考下，希望能给你带来帮助
    2021-07-07
  • 如何获取Maven项目的版本号

    如何获取Maven项目的版本号

    最近需要在项目中获取项目的版本号，最笨的方法莫过于硬编码一个版本号，当然之前我也是这么干的。不过闲下来的时候突发奇想Spring Boot项目中pom.xml定义的版本号（也就是project.version的值）能不能通过API获得呢？于是利用摸鱼的时间研究了这种无聊透顶的东西。
    2021-05-05
  • Jmeter访问需要登录的接口如何处理问题

    Jmeter访问需要登录的接口如何处理问题

    这篇文章主要介绍了Jmeter访问需要登录的接口如何处理问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • springboot集成tkmapper及基本使用教程

    springboot集成tkmapper及基本使用教程

    tk.mybatis可以节省程序员的大部分时间，对于程序员来说关于一张表的操作无非就是增删改查，tk.mybatis提供了一些基本操作的SQL语句，比如说按表的主键查询、删除等基本操作，我们接下来就来介绍一些springboot集成tkmapper及基本使用
    2022-11-11
  • javaSwing写关闭窗口的提示框实例

    javaSwing写关闭窗口的提示框实例

    这篇文章主要介绍了javaSwing写关闭窗口的提示框实例，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-12-12
  • Java 如何实现时间控制

    Java 如何实现时间控制

    这篇文章主要向大家介绍得是Java 如何实现时间控制，文章珠岙举例说明该内容，感兴趣得小伙伴可以跟小编一起学习下面文章内容
    2021-10-10
  • 详解Java中数组判断元素存在几种方式比较

    详解Java中数组判断元素存在几种方式比较

    这篇文章主要介绍了Java中数组判断元素存在几种方式比较，非常不错，具有一定的参考借鉴价值，需要的朋友参考下吧
    2018-07-07

最新评论