SpringBoot整合Swagger2接口文档

目录

使用背景

一、搭建SpringBoot框架

二、添加依赖

三、添加配置

四、创建两个配置类

开始测试

添加说明

效果


使用背景

因为前后端分离的原因,接口文档越来越重要,它上面记录着 连接前后端的路径、访问方式、字段

自己写接口文档-麻烦

所以用Swagger2,它可以自动生成接口文档。

Swagger2官方说明文档:http://springfox.github.io/springfox/docs/2.9.2/#getting-started

一、搭建SpringBoot框架

SpringBoot框架快速入门搭建Hello Worldicon-default.png?t=M85Bhttps://blog.csdn.net/KangYouWei6/article/details/127018638?spm=1001.2014.3001.5501

二、添加依赖

在pom.xml中加上 

<!--整合Swagger2接口文档-->
<!-- 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>

三、添加配置

下面修改成自己项目使用

尤其是包那一块,要修改成自己对应的controller层路径

#Swagger2接口文档
  #下面的根据自己的项目来写
  #最重要的事basePackageRest,后面写的是controller层的路径
swagger:
  title: 校园管理系统的API
  description: 作者:康有为 时间:2022/09/25
  version: 1.0
  contactName: lxt
  contactEmail: www.baidu.com
  contactUrl: www.bilibili.com
  basePackageRest: com.kyw.controller
  termsOfServiceUrl:

四、创建两个配置类

在com.kyw.config下创建 SwaggerProperties 的类文件

package com.kyw.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "swagger")
@Data
public class SwaggerProperties {
    private String title;
    private String contactName;
    private String contactUrl;
    private String contactEmail;
    private String version;
    private String description;
    private String basePackageRest;
    private String termsOfServiceUrl;
}
 

在com.qcby.config下创建 SwaggerConfig 的类文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Autowired
    private SwaggerProperties swaggerProperties;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("REST接口")
                .apiInfo(apiInfo())
                .select()
                //  配置自动扫描那些包下类型生成接口文档
                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackageRest()))
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title(swaggerProperties.getTitle())
                //创建人
                .contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(),swaggerProperties.getContactEmail()))
                //版本号
                .version(swaggerProperties.getVersion())
                //描述
                .description(swaggerProperties.getDescription())
                .build();
    }
}

到这里配置完毕了!

开始测试

直接访问

http://localhost:8081/swagger-ui.html

会显示下面的效果

添加说明

在controller类的上面加上注解来说明

//  controller类
@Api(tags = {"登录模块"})

 在controller类的方法上面添加注解来说明方法

// 方法
@ApiOperation("登录接口")

在实体类(entity层)的上面加上注解来说明实体类

// 实体类  
@ApiModel("用户实体")   

在实体类字段的上面加上注解用来说明字段

@ApiModel("学生实体")
public class Student {
    @ApiModelProperty(value = "学生id")
    private Integer id;
    @ApiModelProperty(value = "学生姓名")
    private String name;
    @ApiModelProperty(value = "学生学号")
    private String sno;
    @ApiModelProperty(value = "学生性别")
    private String sex;
 

在controller的方法的上面加上注解来说明方法的参数

// 参数
@ApiImplicitParams(
    {@ApiImplicitParam(name = "id", 
        value = "用户的id", required = true, 
        dataType = "Long", paramType = "header")
    ,
        @ApiImplicitParam(name = "name", 
        value = "用户的name", required = true, 
        dataType = "String", paramType = "header")
        
    }
        )

效果

 

 喜欢的话点个吧,谢谢你的观看

 

 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
要实现springboot整合swagger2 3.0.0版本,你需要按照以下步骤操作: 1. 创建一个maven项目并引入spring-boot-starter-web和springfox-boot-starter依赖。在pom.xml文件中添加以下代码: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!-- <version>2.5.6</version> --> <!-- <version>2.6.3</version> --> <!-- <version>2.6.5</version> --> <version>2.7.3</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.26</version> </dependency> ``` 2. 在application.yml配置文件中添加以下内容: ```yaml spring: mvc: pathmatch: matching-strategy: ant_path_matcher ``` 3. 创建启动类,并在其中添加`@EnableSwagger2`注解。例如: ```java @SpringBootApplication @EnableSwagger2 public class YourApplication { public static void main(String[] args) { SpringApplication.run(YourApplication.class, args); } } ``` 这样就完成了springboot整合swagger2 3.0.0版本的配置。你可以根据需要在项目中编写相应的接口文档注解以及其他相关配置。如果需要更详细的操作步骤和示例代码,你可以参考中提供的链接。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [Springboot整合Swagger2(3.0.0版本)](https://blog.csdn.net/mo_sss/article/details/130820204)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [Springboot整合Swagger UI 3.0.0 版本](https://blog.csdn.net/qq_42102911/article/details/126410050)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值