swagger2学习-整合springboot

目录

一、swagger简介

二 springboot集成

2.1 导包

2.2 添加配置文件SwaggerConfig.java

2.3 页面展示

2.4 使用方式

---

一、swagger简介

        Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码，了解更多内容，见参考资料。

        Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

二 springboot集成

2.1 导包

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2.2 添加配置文件SwaggerConfig.java

内容如下

package com.yty.system.config;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yty.system.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("XXXX管理平台")
                        .description("XXXX管理平台")
                        .version("9.0")
                        .contact(new Contact("大肥虫","www.dafeichong.net","dafeichong@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.dafeichong.com")
                        .build());
    }
}
注意几个关键词：

basePackage：controller扫描的包名

2.3 页面展示

2.4 使用方式

新建UserController.java类

如下：

package com.yty.system.controller;


import com.yty.system.config.Producer;
import com.yty.system.config.RocketMQConfig;
import com.yty.system.entity.vo.R;
import io.swagger.annotations.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author addd
 * @since 2022-06-12
 */
@RestController
@RequestMapping("/user")
@Api(tags = "用户管理API")
public class UserController {


    @GetMapping("list")
    @ApiOperation(value = "查询列表接口",notes = "查询所有的用户信息")    // 接口名称和描述
    @ApiImplicitParams(
            {
                    @ApiImplicitParam(name = "userName",value = "用户名"),
                    @ApiImplicitParam(paramType = "query",name = "pageNo",value = "起始页",dataType = "int",example = "1",required = true),
                    @ApiImplicitParam(paramType = "query",name = "pageSize",value = "每页显示的条数",dataType = "int",example = "10",required = true)
            })
    @ApiResponses({
            @ApiResponse(code = 200,message = "返回data字段说明",response = R.class)
    })
    public R listUser(String userName,Integer pageNo,Integer pageSize){
        List<String> list = new ArrayList<String>();
        return R.ok(list);
    }

    @DeleteMapping("deleteUser")
    @ApiOperation(value = "删除用户信息",notes = "删除用户信息")    // 接口名称和描述
    public R deleteUser(){
        return R.ok();
    }
}

 post请求之json传递参数

---