Spring Cloud Zuul集成Swagger實(shí)現(xiàn)過(guò)程解析

更新時(shí)間：2020年11月09日 09:51:40 作者：dreamstar

這篇文章主要介紹了Spring Cloud Zuul集成Swagger實(shí)現(xiàn)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

Spring Cloud Zuul 集成Swagger

1.準(zhǔn)備服務(wù)注冊(cè)中心eureka-server

2.創(chuàng)建微服務(wù)swagger-service-a

step1. 創(chuàng)建微服務(wù)swagger-service-a(Spring Boot項(xiàng)目)，添加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 ，，將當(dāng)前應(yīng)用添加到服務(wù)治理體系中，開(kāi)啟微服務(wù)注冊(cè)與發(fā)現(xiàn)。

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 實(shí)例文檔")
        .description("swagger-service-a 實(shí)例文檔 1.0")
        .termsOfServiceUrl("https:github")
        .version("1.0")
        .build();
  }

}

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

#微服務(wù)基本信息
spring.application.name=swagger-service-a
server.port=10010
#注冊(cè)中心
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
#要生成文檔的package
swagger.base-package=com.example

step5.添加一個(gè)微服務(wù)提供的功能

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.啟動(dòng)微服務(wù)，訪問(wèn) http://localhost:10010/swagger-ui.html

3.創(chuàng)建微服務(wù)swagger-service-b （參考swagger-service-a ），啟動(dòng)微服務(wù)swagger-service-b并訪問(wèn)http://localhost:10020/swagger-ui.html

4.構(gòu)建API網(wǎng)關(guān)并整合Swagger

step1.創(chuàng)建API網(wǎng)關(guān)微服務(wù)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 實(shí)例文檔")
        .description("swagger-service 實(shí)例文檔 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文件中添加配置

#微服務(wù)基本信息
spring.application.name=swagger-api-gateway
server.port=10030
#注冊(cè)中心
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
#要生成文檔的package
swagger.base-package=com.example

step6.啟動(dòng)微服務(wù)，訪問(wèn)http://localhost:10030/swagger-ui.html

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

相關(guān)文章

Java使用正則表達(dá)式判斷字符串是否以字符開(kāi)始
這篇文章主要介紹了Java使用正則表達(dá)式判斷字符串是否以字符開(kāi)始的相關(guān)資料,需要的朋友可以參考下
2017-06-06
Mybatis逆工程的使用
最近在學(xué)Mybatis，類似Hibernate，Mybatis也有逆工程可以直接生成代碼(mapping,xml,pojo)，方便快速開(kāi)發(fā)。這篇文章給大家介紹Mybatis逆工程的使用相關(guān)知識(shí)，感興趣的朋友一起看下吧
2016-06-06
淺談java中的重載和重寫的區(qū)別
本文主要介紹了java中的重載和重寫的區(qū)別。具有一定的參考價(jià)值，下面跟著小編一起來(lái)看下吧，希望能夠給你帶來(lái)幫助
2021-11-11
Java多線程:生產(chǎn)者與消費(fèi)者案例
這篇文章主要介紹了Java并發(fā)編程中的生產(chǎn)者與消費(fèi)者模型簡(jiǎn)述,多線程并發(fā)是Java編程中最終要的部分之一,需要的朋友可以參考下，希望能給你帶來(lái)幫助
2021-07-07
如何獲取Maven項(xiàng)目的版本號(hào)
最近需要在項(xiàng)目中獲取項(xiàng)目的版本號(hào)，最笨的方法莫過(guò)于硬編碼一個(gè)版本號(hào)，當(dāng)然之前我也是這么干的。不過(guò)閑下來(lái)的時(shí)候突發(fā)奇想Spring Boot項(xiàng)目中pom.xml定義的版本號(hào)（也就是project.version的值）能不能通過(guò)API獲得呢？于是利用摸魚的時(shí)間研究了這種無(wú)聊透頂?shù)臇|西。
2021-05-05
Jmeter訪問(wèn)需要登錄的接口如何處理問(wèn)題
這篇文章主要介紹了Jmeter訪問(wèn)需要登錄的接口如何處理問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
2023-11-11
springboot集成tkmapper及基本使用教程
tk.mybatis可以節(jié)省程序員的大部分時(shí)間，對(duì)于程序員來(lái)說(shuō)關(guān)于一張表的操作無(wú)非就是增刪改查，tk.mybatis提供了一些基本操作的SQL語(yǔ)句，比如說(shuō)按表的主鍵查詢、刪除等基本操作，我們接下來(lái)就來(lái)介紹一些springboot集成tkmapper及基本使用
2022-11-11
這篇文章主要介紹了javaSwing寫關(guān)閉窗口的提示框?qū)嵗?，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2021-12-12