JavaEE_Swagger

最新推荐文章于 2022-08-18 16:54:18 发布
最新推荐文章于 2022-08-18 16:54:18 发布
阅读量230 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40828705/article/details/104511334
版权

1.学习目标
了解Swagger的作用和概念
了解前后端分离
在SpringBoot中集成Swagger
2.Swagger简介
前后端分离：
Vue + SpringBoot
后端时代：前端只用管理静态页面；html->后端，模板引擎 JSP->后端是主力。
前后端分离时代：
后端：后端控制层，服务层，数据访问层【后端团队】。
前端：前端控制层，视图层【前端团队】
前端后端如何交互：----> JSP
前后端相对独立，松耦合。
前后端甚至可以部署在不同的服务器上。

产生一个问题：
前后端集成联调，前端人员和后端人员无法做到“即使协商，尽早解决”，最终导致问题集中爆发。
解决方案：
首先指定schema计划的提纲，实时更新API，降低集成的风险；
早些年，指定word文档。
前后端分离：
前端测试后端接口：postman
后端提供接口，需要实时更新最新的消息及改动。

Swagger
号称世界上最流行的API框架；
RestFul API文档在线生成工具—>API文档与API定义同步更新；
直接运行，可以在线调试API接口；
支持多种于语言：(Java、Php)

官网：
在项目中使用Swagger需要Springbox：
Swagger2
ui

SprongBoot集成Swagger
1.新建一个SpringBoot项目：
2.导入依赖

	<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

3.编写一个Hello工程
4.配置Swager--->Config

	
@Configuration //等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {
}

5.测试运行：
	http://localhost:8989/swagger-ui.html
测试图如下：

在这里插入图片描述
配置Swager
Swagger的Bean实例Docket：

package com.kuang.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {

    // 配置了Swager的Docket的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){

        // 作者信息
        Contact contact = new Contact("马炳阳", "https:", "957935694@qq.comn");
        return new ApiInfo(
                "maby的swagger文档",
                "maby很酷",
                "1.0",
                "http://",
                contact,
                "Apache2.0",
                "www",
                new ArrayList<>()
        );
    }
}

在这里插入图片描述
Swagger配置扫描接口
Docket.select()

package com.kuang.swagger.config;

import com.kuang.swagger.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {

    // 配置了Swager的Docket的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // basePackage指定要扫描的包 生成对应的api接口
                // any() 扫描全部
                // none() 不扫描
                // withClassAnnotation 扫描类上的注解 参数是一个注解的反射对象 一般应basePackage
                .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //.apis(RequestHandlerSelectors.withClassAnnotation(.class))
                // paths 过滤路径
                .paths(PathSelectors.ant("/kuang/**")) // 扫描kuang下面的接口
                .build()
                ; // 工厂模式
    }

    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){

        // 作者信息
        Contact contact = new Contact("马炳阳", "https:", "957935694@qq.comn");
        return new ApiInfo(
                "maby的swagger文档",
                "maby很酷",
                "1.0",
                "http://",
                contact,
                "Apache2.0",
                "www",
                new ArrayList<>()
        );
    }
}

在这里插入图片描述

配置是否启动Swagger

package com.kuang.swagger.config;

import com.kuang.swagger.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {

    // 配置了Swager的Docket的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false) // 是否启用Swagger false swagger不能在浏览器中访问
                .select()
                // basePackage指定要扫描的包 生成对应的api接口
                // any() 扫描全部
                // none() 不扫描
                // withClassAnnotation 扫描类上的注解 参数是一个注解的反射对象 一般应basePackage
                .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //.apis(RequestHandlerSelectors.withClassAnnotation(.class))
                // paths 过滤路径
                //.paths(PathSelectors.ant("/kuang/**"))
                .build()
                ; // 工厂模式
    }

    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){

        // 作者信息
        Contact contact = new Contact("马炳阳", "https:", "957935694@qq.comn");
        return new ApiInfo(
                "maby的swagger文档",
                "maby很酷",
                "1.0",
                "http://",
                contact,
                "Apache2.0",
                "www",
                new ArrayList<>()
        );
    }
}

在这里插入图片描述
判断是不是生产环境：

server:
  port: 8989
spring:
  profiles:
    active: dev

server:
  port: 8990

server:
  port: 8991

package com.kuang.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {

    // 配置了Swagger的Docket的Bean实例
    @Bean
    public Docket docket(Environment environment){

        // 设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev","test"); // 返回目前的Profiles

        // 获取项目的环境：
        // 通过 environment.acceptsProfiles(profiles);判断是否处在自己设定的环境中
        boolean acceptsProfiles = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(acceptsProfiles) // 是否启用Swagger false swagger不能在浏览器中访问
                .select()
                // basePackage指定要扫描的包 生成对应的api接口
                // any() 扫描全部
                // none() 不扫描
                // withClassAnnotation 扫描类上的注解 参数是一个注解的反射对象 一般应basePackage
                .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //.apis(RequestHandlerSelectors.withClassAnnotation(.class))
                // paths 过滤路径
                //.paths(PathSelectors.ant("/kuang/**"))
                .build()
                ; // 工厂模式
    }

    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){

        // 作者信息
        Contact contact = new Contact("马炳阳", "https:", "957935694@qq.comn");
        return new ApiInfo(
                "maby的swagger文档",
                "maby很酷",
                "1.0",
                "http://",
                contact,
                "Apache2.0",
                "www",
                new ArrayList<>()
        );
    }
}

配置API文档的分组：

package com.kuang.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration // 等价于component
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {

    // 配置了Swagger的Docket的Bean实例
    @Bean
    public Docket docket(Environment environment){

        // 设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev","test"); // 返回目前的Profiles

        // 获取项目的环境：
        // 通过 environment.acceptsProfiles(profiles);判断是否处在自己设定的环境中
        boolean acceptsProfiles = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("马炳阳")
                .enable(acceptsProfiles) // 是否启用Swagger false swagger不能在浏览器中访问
                .select()
                // basePackage指定要扫描的包 生成对应的api接口
                // any() 扫描全部
                // none() 不扫描
                // withClassAnnotation 扫描类上的注解 参数是一个注解的反射对象 一般应basePackage
                .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //.apis(RequestHandlerSelectors.withClassAnnotation(.class))
                // paths 过滤路径
                //.paths(PathSelectors.ant("/kuang/**"))
                .build()
                ; // 工厂模式
    }

    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){

        // 作者信息
        Contact contact = new Contact("马炳阳", "https:", "957935694@qq.comn");
        return new ApiInfo(
                "maby的swagger文档",
                "maby很酷",
                "1.0",
                "http://",
                contact,
                "Apache2.0",
                "www",
                new ArrayList<>()
        );
    }
}

在这里插入图片描述
如何配置多个分组：
.groupName(“马炳阳”)与Docket相关。


 @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("A");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("A");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("A");
    }


org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.IllegalStateException: Multiple Dockets with the same group name are not supported. The following duplicate groups were discovered. A

在这里插入图片描述

package com.kuang.swagger.pojo;

public class User {

    public String username;

    public String password;
}

package com.kuang.swagger.controller;

import com.kuang.swagger.pojo.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController![在这里插入图片描述](https://img-blog.csdnimg.cn/20200226132238951.PNG?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwODI4NzA1,size_16,color_FFFFFF,t_70)
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }

    // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }

}

在这里插入图片描述

package com.kuang.swagger.pojo;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel("用户实体类")
public class User {

    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

在这里插入图片描述

package com.kuang.swagger.controller;

import com.kuang.swagger.pojo.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

// @Api("Hellokongzhilei") 此处无用
@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }

    // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }

    @ApiOperation("Hello控制类") // 不是放在类上的
    @GetMapping(value = "/hello2")
    public String hello(@ApiParam("用户名") String username){
        return "hello2" + username;
    }

    @ApiOperation("Post测试类") // 不是放在类上的
    @PostMapping(value = "/postt")
    public User postt(@ApiParam("用户名") User user){
        int i = 5 / 0;
        user = new User("maby0","000000");
        return  user;
    }
}

在这里插入图片描述
总结：
1.我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息。
2.接口文档实时更新。
3.可以在线调试。
Swagger是一个优秀的工具，几乎所有的大公司都有使用它。
【注意点】在正是发布时，关闭Swagger！！！ 处于安全考虑，而且节省运行的内存。

炳烛之明科技
关注
Spring Boot 集成 Swagger UI
AI天才研究院
08-03 1544
作者：禅与计算机程序设计艺术Swagger（也被称作OpenAPI Specification）是一个开放源代码的项目，用于定义、描述、产生、消费RESTful API，目前已成为事实上的标准。其主要功能包括：Swagger是一个开源的API开发规范，提供了一系列工具，能够帮助设计人员、工程师快速编写清晰的API文档，从而方便其他开发者调用API。Spring Boot是一个由Pivotal团队提供的新型开源框架，其旨在帮助开发人员快速搭建单体或微服务架构中的应用。它简化了配置，通过自动装配组件和服务，降低
Swagger4EE:Swagger 在没有所有依赖的 Java EE Rest 上
06-14
Swagger4EE Swagger 在没有所有依赖的 Java EE Rest 上。 像这样使用它。 您还需要在您的 Configclass 中添加 JacksonFeature。 公共类 MySwaggerResource 扩展 SwagResource { @Override public String getSwaggerUrl() { String url = "http://localhost:9080/CSDistribution/rest"; return url; } @Override public Class<?>[] getResourcesForSwagging() { return new Class[]{CockpitResource.class,ArkiverOgRegisterResource.class}; } }
JavaEE：Swagger使用
a526001650a的专栏
08-15 224
说明： API规范，规范RESTful开发过程 1.在工程/pom.xml中导入swagger依赖包： <dependencies> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</ver......
[JavaEE] Create API documents with Swagger
weixin_33697898的博客
08-06 87
We mainly need to modify our Model and REST endpoint code to enable swagger Document. model/Book.java: By doing this, we can get each model defination in swagger rest/BookRespostory.java: By doing t...
JavaEE（22）SpringBoot--Swagger
nswzr的博客
02-22 172
1. Swagger介绍 1. 前后端分离 （1）前后端分离 前端：控制层、视图层 后端：控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合 （2）产生的问题：前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发 2. Swagger介绍 号称世界上最流行的API框架 Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新 直接运行，在线测试API 支持多种语言 （如：Java，PHP等） 官网：https://swa
【Java】java | swagger用法
hgSuper的博客
08-18 526
1、备份下swagger用法。
javaEE_Spring Boot
01-12
配合Swagger等工具，可以生成API文档，提高开发协作效率。 在日志管理上，Spring Boot默认集成了Logback或Log4j2，开发者可以很方便地调整日志级别和输出格式，便于应用监控和问题排查。 安全方面，Spring Boot...
SpringMVC如何在生产环境禁用Swagger的方法
08-27
return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfoOnline()) .select() .paths(PathSelectors.none());//如果是线上环境，添加路径过滤，设置为全部都不符合 .build(); }else { return new ...
cifojava2021-javaee-5:带有@RestController 和 Swagger 的 Spring Boot 连接到 H2 本地数据库和用于图像的 MongoDB 云数据库
08-04
带有图像public class EmployeeImageController和 Swagger 的 Rest Controller 应用程序属性 类：JPA @Entity Employee 和 CrudRepository 接口 数据库：H2（本地或内存中）和 ddl.auto用于数据 用于图像的MongoDB...
JavaEE开发中Lombok、Swagger、SpringBoot、SpringCloud常用注解
林大侠
11-11 535
一、Lombok常用注解 官网：https://projectlombok.org/contributing/index github地址：https://github.com/rzwitserloot/lombok   Lombok项目是一个Java库，应用注解简化JavaBean的开发！   常用注解如下： 注解 描述 @Data 类上注解，为类的所有属性都提供get()、...
为你的 Java Web 项目加入 Swagger
Jake Weng
11-07 2031
Swagger for Spring Boot Swagger 可用于生成、描述、调用和可视化 RESTful 风格接口的API，是一套规范和完整的开发框架，并且能对接口进行单独测试。 Spring Boot 是目前对 Swagger 支持最好的框架，只需要引入 springfox-swagger 相关依赖： <dependency> <groupId>io.spr...
java项目Swagger工具使用方法
wujian_csdn_csdn的博客
01-01 5943
swagger对应后端开发而言，几乎就是一个神器，调试后端api接口非常好用的工具，我们项目是分布式微服务架构，利用Spring Cloud技术，那么如何在java项目中配置好，分为下面几个步骤： 1、在独自的服务模块启动类中加载 以下是启动数据库连接、FeignClientConfig、CommonConfig、SwaggerConfig等整体服务信息。 package xxxxx.test; ...
java使用原生swagger_java集成swagger
weixin_35682020的博客
02-24 422
概览：java集成SwaggerSwagger-UI的使用Springboot跨域请求的访问解决Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。本文主要介绍了在 Spring Boot 添加 Swagger 支持， 生成可自动维护的 API 文档。1 . POM文件概览：org.springframework.bootspring-boo...
Swagger，好用的API管理神器（swagger学习简单总结）
Earl_yuan的专栏
06-04 8130
一、swagger简介1.1. swagger是什么？ THE WORLD’S MOST POPULAR API TOOLING Swagger is the world’s largest framework of API developer tools for the OpenAPI Specification(OAS), enabling development across the
【Java】--swagger使用
寻梦友的博客
07-24 1341
介绍springboot集成swagger的方法
Swagger技术
sxh06的博客
09-17 611
Swagger技术Swagger的作用与概念在项目中使用swagger配置swaggerApiInfo 配置swagger配置扫描接口配置api文档分组多个分组实体类配置 Swagger的作用与概念 Swagger官网，点此进入 在前后端分离时代，我们需要实时自动更新接口信息，和测试接口，实现前后端分离式开发，swagger因此产生 在项目中使用swagger 以下以3.0.0依赖为例 <!--swagger 相关组件--> <dependency>
Swagger2配置文件
积木
07-02 3425
@Configuration @EnableSwagger2 public class Swagger2Config { @Bean public Docket webApiConfig(){ return new Docket(DocumentationType.SWAGGER_2) .groupName("webApi") .apiInfo(webApiInfo()) .s
SpringMVC+Swagger UI生成可视图的API文档（详细图解）
热门推荐
x_k的专栏
12-04 5万+
SpringMVC+Swagger生成文档详细图解，以及遇到的异常处理
Java Swagger：（五）Swagger 配置
地球村
08-14 1992
Swagger 配置1.配置基本信息2.设置扫描的包3.自定义注解设置不需要生成接口文档的方法3.1 自定义注解3.2 添加规则3.3 添加 NotIncludeSwagger 注解4.设置范围 可以在项目中创建 SwaggerConfig，进行配置文档内容。 1.配置基本信息 Docket：摘要对象，通过对象配置描述文件的信息。 apiInfo:设置描述文件中 info。参数类型 ApiInfo select():返回 ApiSelectorBuilder 对象，通过对象调用 build()可以创建
idea的JAVAEE_TYPE
最新发布
11-14
根据提供的引用内容，没有明确的提到`JAVAEE_TYPE`，不过根据常识推测，`JAVAEE_TYPE`可能是指JavaEE的类型。JavaEE是Java Platform, Enterprise Edition的缩写，是一种基于Java语言的企业级应用开发标准，主要用于开发大型、复杂的企业级应用。在IDEA中，可以通过设置项目的类型来选择JavaEE的版本和类型，例如Web Application、Enterprise Application等。这些类型的选择会影响到项目的结构和配置文件的生成。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值