当前位置:首页 > 服务端 > Swagger

Swagger

2022年08月05日 22:57:31服务端6

Swagger

学习目标:

  • 了解Swagger的作用和概念
  • 了解前后端分离
  • 在SpringBoot中集成Swagger

一、Swagger简介

前后端分离:

Vue+SpringBoot

后端时代:前端只用管理静态页面,html>后端。模板引擎JSP>后端是主力

前后端分离时代:

  • 后端:后端控制层,服务层,数据访问层

  • 前端:前端控制层,视图层,伪造后端数据,json,已经存在了,不需要后端,前端工程依旧能跑起来

  • 前后端如何交互?==>API接口

  • 前后端相对独立,松耦合

  • 前后端甚至可以部署在不同服务器上

产生一个问题:

  • 前后端集成联调,前端人员和后端人员无法做到即使协商,需要尽早解决,最终导致问题集中爆发

解决方法:

  • 首先指定一个Schema,实时更新最新API,降低集成风险
  • 早些年指定world计划文档
  • 前后端分离:前端测试后端接口:postman,后端提供接口,需要试试更新最新的消息及改动

swagger号称世界上最流行的API框架,优点:

  • RestFul API文档在线自动生成工具==>API文档与API定义同步更新

  • 直接运行,可以在线测试API接口

  • 支持多种语言(JAVA,PHP)

  • 官网:https://swagger.io/

在项目中使用Swagger需要导入jar包

  • swagger2
  • ui

二、SpringBoot集成Swagger

1、新建一个SpringBoot-Web项目

2、导入相关依赖

<!-- 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>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

3、编写一个Hello工程

4、配置Swagger==>config

@Configuration
@EnableSwagger2//开启Swagger
public class SwaggerConfig {
}

5、测试运行:http://localhost:8080/swagger-ui.html

三、配置Swagger

Swagger的bean实例Docket

@Configuration
@EnableSwagger2//开启Swagger
public class SwaggerConfig {
    //配置了Swagger的Docket的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    //配置Swagger信息=apiinfo
    private ApiInfo apiInfo(){
        Contact contact = new Contact("aurora", "http://www.baidu.com", "706915503@qq.com");
        return new ApiInfo("aurora的SwaggerAPI文档",
                "极光永恒", "1.0",
                "http://www.baidu.com", contact, "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList());
    }
}

四、Swagger配置扫描接口

Docket.select()

    //配置了Swagger的Docket的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.aurora.swagger.controller"))
                .paths(PathSelectors.ant("/aurora/**"))
                .build();//RequestHandlerSelectors配置要扫描的包;basePackage指定要扫描的包;build
                        //withClassAnnotation扫描类上的注解,参数是注解的反射对象;withMethodAnnotation扫描方法上的注解
    }

配置是否启动Swagger

.enable(false)

问题:我只希望我的Swagger在生产环境中使用,在发布的时候不使用

  • 判断是不是生产环境
  • 注入enable();
//配置了Swagger的Docket的Bean实例
    @Bean
    public Docket docket(Environment environment){
        //设置要显示的Swagger环境
        Profiles of = Profiles.of("dev","test");
        //获取项目环境,通过 environment.acceptsProfiles(of)判断是否处在自己设定的环境中
        boolean flag = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.aurora.swagger.controller"))
                //.paths(PathSelectors.ant("/aurora/**"))
                .build();//RequestHandlerSelectors配置要扫描的包;basePackage指定要扫描的包;build
                        //withClassAnnotation扫描类上的注解,参数是注解的反射对象;withMethodAnnotation扫描方法上的注解
    }

配置API文档分组

.groupName("aurora")

如何配置多个组

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

实体类配置

//@Api注释@ApiModel("用户实体类")public class User {    @ApiModelProperty("用户名")    public String username;    public String password;}
@RestControllerpublic class HelloController {    @GetMapping("/hello")    public String Hello(){        return "hello";    }    //只要我们的接口中返回值存在实体类,他就会被扫描到Swagger中    @PostMapping("/user")    public User user(){        return new User();    }}
//Operation接口不是放在类上而是在方法上@ApiOperation("Hello控制类")@GetMapping("/hello2")public String Hello2(@ApiParam("用户名") String username){    return "hello";}

总结:

我们可以通过Swagger给一些比较难理解的属性接口,增加注释信息

接口文档实时更新

可以在线测试

Swagger是一个优秀的工具,几乎所有的大公司都有使用

注意点:正式发布时,关闭Swagger,处于安全考虑,而且节省内存

作者:榕城半夏
来源链接:https://www.cnblogs.com/rongchengbanxia/p/15032520.html

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/server/18141.html

标签: Swagger
分享给朋友:

“Swagger” 的相关文章

SpringBoot整合Swagger2

SpringBoot整合Swagger2

相信各位在公司写API文档数量应该不少,当然如果你还处在自己一个人开发前后台的年代,当我没说,如今为了前后台更好的对接,还是为了以后交接方便,都有要求写API文档。   手写Api文档的几个痛点: 文档需要更新的时候,需要再次发送...

Maven + SpringMVC项目集成Swagger

Maven + SpringMVC项目集成Swagger

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

SpringBoot整合Swagger3生成接口文档

SpringBoot整合Swagger3生成接口文档

  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的开发环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。 一、pom文件中引入Swagger3依赖...

springboot成神之——swagger文档自动生成工具

springboot成神之——swagger文档自动生成工具

本文讲解如何在spring-boot中使用swagger文档自动生成工具 目录结构 说明 依赖 SwaggerConfig 开启api界面 JSR 303注释信息 Swagger核...

特别好用的swagger ui 封装

特别好用的swagger ui 封装

Swagger简单介绍 Swagger是一个Restful风格接口的文档在线自动生成和测试的框架 官网:http://swagger.io 官方描述:The World’s Most Popular Framework for APIs. Swagger...

替换swagger-ui,选择款神器—knife4j

替换swagger-ui,选择款神器—knife4j

    一、介绍 knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小...

浅析如何在Nancy中使用Swagger生成API文档

浅析如何在Nancy中使用Swagger生成API文档

介绍了如何在Nancy中使用Swagger生成一份API文档,并且处理在安全验证方面遇到的问题。 前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document。但是还有许许多多的不足。 为了能稍微完善一下这个Docume...

Visual Studio 2017 and Swagger: Building and Documenting Web APIs

Visual Studio 2017 and Swagger: Building and Documenting Web APIs

Swagger是一种与技术无关的标准,允许发现REST API,为任何软件提供了一种识别REST API功能的方法。 这比看起来更重要:这是一个改变游戏技术的方式,就像Web服务描述语言一样WSDL(Web Service Description Language)一样。...

基于 abp vNext 和 .NET Core 开发博客项目

基于 abp vNext 和 .NET Core 开发博客项目

系列文章 基于 abp vNext 和 .NET Core 开发博客项目 - 使用 abp cli 搭建项目 基于 abp vNext 和 .NET Core 开发博客项目 - 给项目瘦身,让它跑起来 基于 abp vNext 和 .NET Core 开...

swagger整合springboot的使用

swagger整合springboot的使用

什么是swagger? Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。