Swagger快速入门【基础总结】

Swagger

背景信息

什么是前后端分离：

即: Vue + Springboot 开发模式

以前是后端时代(后端是主力)：前端只用管理静态页面；html—>后端。

前后端分离时代：

  • 前端 ：前端控制层、视图层【前端团队】
  • 后端：后端控制层、服务层、数据访问层【后端团队】
  • 前后端通过API进行交互【交互方式(http/rpc)】
  • 前后端相对独立且松耦合；
  • 前后端甚至可以部署在不同的服务器上

产生的问题：

前后端集成，前端或者后端无法做到“及时协商解决”，最终导致问题集中爆发

解决方案

  • 定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险
  • 早些年：通过指定word计划文档的方式
    前端测试后端接口：postman
    后端提供接口，需要实时更新最新的消息及改动！

Swagger诞生

官网：https://swagger.io/

  • 号称世界上最流行的API框架
  • Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
  • 直接运行，在线测试API
  • 支持多种语言 （如：Java，PHP等）

入门Demo

1、创建项目环境

  1. 创建一个普通的SpringBoot项目，添加支持web应用的启动器

  2. 添加Maven依赖

    引入SpringBoot集成Swagger的相关Jar包

<!-- 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>
  1. 编写HelloController，测试确保运行成功！
package com.carson.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

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

}
  1. 创建SwaggerConfig配置类：
package com.carson.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}
  1. 启动测试,访问:http://localhost:8080/swagger-ui.html
    在这里插入图片描述

    注: 报错的话更改 spring-boot-starter-parent 版本，降低版本!!

Swagger的配置

在SwaggerConfig配置类中,由于Swagger的实例Bean是Docket类，所以通过配置Docket实例来配置Swaggger

配置基本页面的文档信息

  1. Docket 实例关联上 apiInfo()，可以通过apiInfo()配置文档信息
@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

//配置文档信息
private ApiInfo apiInfo() {
    Contact contact = new Contact("koko", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
    return new ApiInfo(
            "Swagger学习", // 标题
            "学习演示如何配置Swagger", // 描述
            "v1.0", // 版本
            "http://terms.service.url/组织链接", // 组织链接
            contact, // 联系人信息
            "Apach 2.0 许可", // 许可
            "许可链接", // 许可连接
            new ArrayList<>()// 扩展
    );
}
  1. 测试，访问http://localhost:8080/swagger-ui.html
    在这里插入图片描述

配置扫描接口

  1. 对于SwaggerConfig配置类 :
@Bean
public Docket docket() {
    //链式编程
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            //enable设置是否启动Swagger
            .enable(false)
            //通过.select()方法，去配置扫描接口
            .select()
            //RequestHandlerSelectors配置如何扫描接口
            .apis(RequestHandlerSelectors.basePackage("com.carson.controller"))
            // 配置如何通过path过滤,即这里只扫描请求以/carson开头的接口
            .paths(PathSelectors.ant("/carson/**"))
            .build();
}

RequestHandlerSelectors配置的一些方法:

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

PathSelectors配置的一些方法:

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

配置swagger的开启和关闭

  1. SwaggerConfig配置类中：

通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了！

@Bean
public Docket docket(Environment environment) {
    // 设置要显示swagger的环境
    Profiles of = Profiles.of("dev", "test");
    // 判断当前是否处于该环境
    // 通过 enable() 接收此参数判断是否要显示
    boolean b = environment.acceptsProfiles(of);

    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            //enable设置是否启动Swagger
            .enable(b)
            //通过.select()方法，去配置扫描接口
            .select()
            //RequestHandlerSelectors配置如何扫描接口
            .apis(RequestHandlerSelectors.basePackage("com.carson.controller"))
            // 配置如何通过path过滤,即这里只扫描请求以/carson开头的接口
            .paths(PathSelectors.ant("/carson/**"))
            .build();
}

  1. 如何动态配置当项目处于test、dev环境时显示swagger，处于pro时不显示？
    2.1 设置配置文件:
    application.properties:

    spring.profiles.active=dev

    application-dev.properties（开发环境）

    server.port=8081

    application-pro.properties（发布环境）

    server.port=8082

  2. 测试:
    访问: http://localhost:8081/swagger-ui.html时:（开发环境）时,页面正常访问;
    访问: http://localhost:8082/swagger-ui.html时：(发布环境)时,无法访问！！！
    最终实现环境改变的功能！！！

配置API分组

在SwaggerConfig配置类的docket方法中,如果没有配置分组，默认是default。
通过groupName()方法即可配置分组,如下:

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

则配置多个分组的方法: 配置多个docket,如下:

@Bean
public Docket docket1(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

测试,访问:http://localhost:8081/swagger-ui.html,如下:
在这里插入图片描述

swagger常见注解

Swagger的所有注解定义在io.swagger.annotations包下

下面是常见的注解:

Swagger注解注解说明:
@Api(tags = “xxx模块说明”)作用在模块类上
@ApiOperation(“xxx接口说明”)作用在接口方法上
@ApiModel(“xxxPOJO说明”)作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)作用在参数、方法和字段上，类似@ApiModelProperty

对上面注解的使用的例子如下:

1.HelloController类用于页面控制跳转

package com.carson.controller;

import com.carson.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(tags = "1、模块类")
@RestController
public class HelloController {

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

    @PostMapping("/user")
    public User user(){
        return new User();
    }

    @ApiOperation("2、接口方法")
    @GetMapping("/hello02")
    public String toHello02(@ApiParam("5、接口中的参数、方法和字段") String username){
        return "hello" + username;
    }

}

2.User实体类

package com.carson.pojo;

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

@ApiModel("3、模型类(实体类)")
public class User {

    @ApiModelProperty("4、属性-用户名")
    public String username;

    @ApiModelProperty("4、属性-密码")
    public String password;

}

3.测试结果如下:
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

总结:

swagger的功能:

  • 可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息
  • 接口文档可以实时更新
  • 可以在线测试接口

注意: 在正式发布项目的时候，关闭Swagger！！！处于安全考虑（避免其他非公司人员访问项目接口），也同时节省运行内存！！！

创作不易!!感谢观看!!

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/3910.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

客户端安装SSH工具Xshell图解

客户端安装SSH工具Xshell图解

一、客户端安装SSH工具 windows客户端&#xff1a;安装Putty、XShell 或者 SecureCRT Linux客户端&#xff1a;yum install openssh-clients macOS客户端&#xff1a;默认已经安装了SSH客户端 我们这里安装windows客户端&#xff0c;选择XShell 工具。 Xshell5、Xftp5下载&am…
阅读更多...
Linux系统之安装PostgreSQL数据库

Linux系统之安装PostgreSQL数据库

Linux系统之安装PostgreSQL数据库一、PostgreSQL介绍1.PostgreSQL简介2.PostgreSQL特点二、本次实践介绍1.本次实践介绍2.实践环境介绍三、配置PostgreSQL的yum仓库源1.检查本地是否部署PostgreSQL2.配置镜像源3.检查yum仓库镜像源状态四、安装PostgreSQL1.安装PostgreSQL2.初始…
阅读更多...
GPIO的八种模式分析

GPIO的八种模式分析

GPIO是general purpose input output,即通用输入输出端口&#xff0c;作用是负责外部器件的信息和控制外部器件工作。 GPIO有如下几个特点&#xff1a;1.不同型号的IO口数量不同&#xff1b;2&#xff0c;反转快速&#xff0c;每次翻转最快只需要两个时钟周期&#xff0c;以ST…
阅读更多...
dubbo的SPI机制和服务暴露，引用原理

dubbo的SPI机制和服务暴露，引用原理

一、SPI引入&#xff1a;spi标准&#xff1a;1、需要在 classpath 下创建一个目录&#xff0c;该目录命名必须是&#xff1a;META-INF/service2、在该目录下创建一个 properties 文件&#xff0c;该文件需要满足以下几个条件 &#xff1a;2.1 文件名必须是扩展的接口的全路径名…
阅读更多...
量子运算-比算子描述更广泛的一类刻画量子态在客观世界演化的数学工具

量子运算-比算子描述更广泛的一类刻画量子态在客观世界演化的数学工具

参考链接&#xff1a;1.1 量子运算 - 知乎 (zhihu.com)一个量子操作&#xff08;包括量子测量和量子信道&#xff09;指的是把一个密度矩阵变成另一个密度矩阵的变换&#xff0c;一般记为 背景演化算符是酉的。这里考虑考虑特殊的演化-测量。测量对应的算子是投影算子&#xff…
阅读更多...
刘禹锡最经典诗文10首，每一首都是千古名作，读懂受益一生

刘禹锡最经典诗文10首，每一首都是千古名作，读懂受益一生

他是唐代最乐观的诗人&#xff0c;是比他的好友乐天更乐天的人&#xff01;他与柳宗元并称“刘柳”&#xff0c;与韦应物、白居易合称“三杰”&#xff0c;并与白居易合称“刘白”。他是在唐代诗人中&#xff0c;出了名的豪放豁达的刘禹锡。白居易称他为“诗豪”。自“永贞革新…
阅读更多...
Elasticsearch：理解 Master，Elections，Quorum 及 脑裂

Elasticsearch：理解 Master，Elections，Quorum 及 脑裂

集群中的每个节点都可以分配多个角色&#xff1a;master、data、ingest、ml&#xff08;机器学习&#xff09;等。 我们在当前讨论中感兴趣的角色之一是 master 角色。 在 Elasticsearch 的配置中&#xff0c;我们可以配置一个节点为 master 节点。master 角色的分配表明该节点…
阅读更多...
【javaEE】阻塞队列、定时器、线程池

【javaEE】阻塞队列、定时器、线程池

目录 &#x1f334;一、阻塞队列 1.概念 2.生产者消费者模型 3.阻塞队列的实现 &#x1f3f9;二、定时器 1.引出定时器 2.定时器的实现 &#x1f525;三、线程池 1.引出线程池 2.ThreadPoolExecutor 构造方法 3.标准数据库的4种拒绝策略【经典面试题】【重点掌握】 …
阅读更多...
2020年第十一届C/C++ B组第一场蓝桥杯省赛真题

2020年第十一届C/C++ B组第一场蓝桥杯省赛真题

准备参加第十四届蓝桥杯&#xff0c;今天开始刷题目的第一天&#xff0c;下面是2020年第十一届C/C B组第一场蓝桥杯省赛真题&#xff0c;以下是我的做题目心得。跑步训练第一次写的代码失误点如下&#xff1a;第一个错误点是因为好久没有写代码&#xff0c;忘记判断对才能循环&…
阅读更多...
【SCL】博图——先入先出排序法

【SCL】博图——先入先出排序法

使用博图SCL语言来实现先入先出排序 前言 使用SCL完成一个先入先出排序 具体要求&#xff1a;最先输入的一个数值&#xff0c;最先输出出来&#xff0c;下面的数自动向前填充&#xff1b; 注&#xff1a;这里可能有两种理解&#xff1a;一是第一个输入的第一个出来&#xff…
阅读更多...
解析vue中的process.env

解析vue中的process.env

一、介绍 1、process process是 nodejs 下的一个全局变量&#xff0c;它存储着 nodejs 中进程有关的信息。 2、process.env env 是 environment 的简称&#xff0c;process.env属性返回一个包含用户环境的对象。 3、dotenv Dotenv 是一个零依赖的模块&#xff0c;它能将环境变…
阅读更多...
蓝桥杯刷题冲刺 | 倒计时16天

蓝桥杯刷题冲刺 | 倒计时16天

作者&#xff1a;指针不指南吗 专栏&#xff1a;蓝桥杯倒计时冲刺 &#x1f43e;马上就要蓝桥杯了&#xff0c;最后的这几天尤为重要&#xff0c;不可懈怠哦&#x1f43e; 文章目录1.青蛙跳杯子1.青蛙跳杯子 题目 链接&#xff1a; 青蛙跳杯子 - 蓝桥云课 (lanqiao.cn) X 星球的…
阅读更多...
用于人工智能研究的开源Python微电网模拟器pymgrid（入门篇）

用于人工智能研究的开源Python微电网模拟器pymgrid（入门篇）

pymgrid是一个开源Python库&#xff0c;用于模拟微型电网的三级控制&#xff0c;允许用户创建或自行选择的微电网。并可以使用自定义的算法或pymgrid中包含的控制算法之一来控制这些微电网&#xff08;基于规则的控制和模型预测控制&#xff09;。 pymgrid还提供了与OpenAI Gy…
阅读更多...
初识冯诺依曼体系结构

初识冯诺依曼体系结构

目录 1.冯诺依曼体系结构 2.冯诺依曼体系的原理 3.数据流向 4.冯诺依曼体系的意义 1.冯诺依曼体系结构 我们常见的计算机&#xff0c;如笔记本。我们不常见的计算机&#xff0c;如服务器&#xff0c;大部分都遵守冯诺依曼体系。 &#xff08;1&#xff09;输入单元&#xff1a;…
阅读更多...
JavaEE-多线程中wait和notify都有哪些区别？

JavaEE-多线程中wait和notify都有哪些区别？

更多内容请点击了解 本篇文章将详细讲述wait和notify的区别&#xff0c;请往下看 目录 更多内容请点击了解 文章目录 一、wait和notify概念 二、wait()方法详解 三、notify()方法详解 代码如下&#xff1a; 3.1notifyAll()详解 四、wait和sleep的对比 一、wait和notif…
阅读更多...
Docker容器高级篇

Docker容器高级篇

文章目录一、Dockerfile文件1.dockerfile基础知识2.docker执行dockerfile的大致流程3.dockerfile常用保留字4.dockerfile构建镜像示例二、docker network1.docker net常用指令2.docker的网络模式三、docker-compose容器编排1.下载安装2.三个步骤3.compose常用命令4.不使用docke…
阅读更多...
Java Web 实战 17 - 计算机网络之传输层协议(2)

Java Web 实战 17 - 计算机网络之传输层协议(2)

大家好 , 这篇文章继续给大家讲解 TCP 协议当中的一些操作 , 比如 : 滑动窗口、流量控制、拥塞控制、延时应答、捎带应答、面向字节流这几个提升 TCP 效率的操作 . 我们还会给大家分析 TCP 连接出现异常的时候 , 该如何处理 . 最后会将 TCP 和 UDP 进行比较 上一篇文章的链接也…
阅读更多...
【计组】RAM的深入理解

【计组】RAM的深入理解

一、存储机理 RAM的实现逻辑有种&#xff0c;分别是触发器和电容。 SRAM&#xff08;Static&#xff09;DRAM&#xff08;Dynamic&#xff09;存储方式触发器电容破坏性读出否&#xff08;触发器具有稳态&#xff0c;能够锁住0或1两种状态&#xff09;是&#xff08;电容需要…
阅读更多...
面试热点题：回溯算法 递增子序列与全排列 II

面试热点题：回溯算法 递增子序列与全排列 II

前言&#xff1a; 如果你一点也不了解什么叫做回溯算法&#xff0c;那么推荐你看看这一篇回溯入门&#xff0c;让你快速了解回溯算法的基本原理及框架 递增子序列 给你一个整数数组 nums &#xff0c;找出并返回所有该数组中不同的递增子序列&#xff0c;递增子序列中 至少有两…
阅读更多...
K8S + GitLab + Jenkins自动化发布项目实践（二）

K8S + GitLab + Jenkins自动化发布项目实践（二）

K8S GitLab Jenkins自动化发布项目实践&#xff08;二&#xff09;Jenkins容器化部署部署NFS PV存储Jenkins部署Jenkins初始化安装Jenkins插件Jenkins主从架构配置Kubernetes插件配置安装nerdctl工具自定义Jenkins Slave镜像测试主从架构是否正常前置工作&#xff1a;已部署5…
阅读更多...
最新文章

Copyright @ 2022~2023