Springboot配置Swagger2
创始人
2024-03-22 07:17:09
0

方式:创建Java类来配置Swagger设置

1.在pom.xml添加依赖

        io.springfoxspringfox-swagger22.9.2
io.springfoxspringfox-swagger-ui2.9.2

2.创建Swagger的Java配置类

package com.yhq.logintest.Utils;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;@Configuration
public class SwaggerUtil {@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.SWAGGER_2).pathMapping("/").select().apis(RequestHandlerSelectors.basePackage("com.yhq.logintest.controller")).paths(PathSelectors.any()).build().apiInfo(new ApiInfoBuilder().title("登陆测试").description("用于登陆测试").version("1.0").build());}
}

3.在启动类添加注解@EnableSwagger2

package com.yhq.logintest;import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;@EnableSwagger2
@SpringBootApplication
@MapperScan("com.yhq.logintest.mapper")
public class LoginTestApplication {public static void main(String[] args) {SpringApplication.run(LoginTestApplication.class, args);}}

swagger2 相关注解说明

1.@Api

说明:用在请求的类上(controller),说明该类的作用
属性:tags=“说明该类的作用”,value=“该参数没什么意义,不需要配置”
示例:@Api(tags = “登陆”)

2.@ApiOperation

说明:用在请求的方法上,说明方法的作用
属性:value=“说明方法的作用”,notes=“方法的备注说明”
示例:@ApiOperation(value=“用户注册”,notes=“手机号,密码都是比输项,年龄限制为数字”)

3.@ApiImplicitParams

说明:用在请求的方法上,包含一组参数说明,@ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息
属性
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)–> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType=“Integer”
defaultValue:参数的默认值
示例:@ApiImplicitParams({
@ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”),
@ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”),
@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)
})

4. @ApiResponses

说明:用于请求的方法上,表示一组响应,@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
属性
code:状态码,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
示例:@ApiOperation(value = “select1请求”,notes = “多个参数,多种的查询参数类型”)
@ApiResponses({
@ApiResponse(code=400,message=“请求参数没填好”),
@ApiResponse(code=404,message=“请求路径没有或页面跳转路径不对”)
})

5. @ApiModel

说明:用于响应类上,表示一个返回响应数据的信息
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
示例

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{@ApiModelProperty(value = "是否成功")private boolean success=true;@ApiModelProperty(value = "返回对象")private Object data;@ApiModelProperty(value = "错误编号")private Integer errCode;@ApiModelProperty(value = "错误信息")private String message;/* getter/setter */
}

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...