SpringBoot2 学习8集成 swagger2

拼搏现实的明天。 2021-07-27 01:14 486阅读 0赞

# 效果 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gzNTYzNjM_size_16_color_FFFFFF_t_70]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gzNTYzNjM_size_16_color_FFFFFF_t_70 1]

# 实现步骤 #

*  添加jar

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

*  配置类

package com.zz.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.ApiInfo;
    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 buildDocket() {
            return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInf())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zz.controller"))
                .paths(PathSelectors.any())
                .build();
        }
        private ApiInfo buildApiInf() {
            return new ApiInfoBuilder()
                .title("系统RESTful API文档")
                .contact(new Contact("Bsea", "https://me.csdn.net/h356363", "yinyouhai@aliyun.com"))
                .version("1.0")
                .build();
        }
    }

*  controller

package com.zz.controller;
    
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.DeleteMapping;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.PutMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    import com.zz.entity.User;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiImplicitParams;
    import io.swagger.annotations.ApiOperation;
    import springfox.documentation.annotations.ApiIgnore;
    
    @Api(value = "用户Controller")
    @Controller
    @RequestMapping("user")
    public class UserController {
    
        @ApiIgnore
        @GetMapping("hello")
        public @ResponseBody String hello() {
            return "hello";
        }
    
        @ApiOperation(value = "获取用户信息", notes = "根据用户id获取用户信息")
        @ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "Long", paramType = "path")
        @GetMapping("/{id}")
        public @ResponseBody User getUserById(@PathVariable(value = "id") String id) {
            User user = new User();
            user.setId(id);
            user.setName("mrbird");
            user.setAge(25);
            return user;
        }
    
        @ApiOperation(value = "获取用户列表", notes = "获取用户列表")
        @GetMapping("/list")
        public @ResponseBody List<User> getUserList() {
            List<User> list = new ArrayList<>();
            User user1 = new User();
            user1.setId("1l");
            user1.setName("mrbird");
            user1.setAge(25);
            list.add(user1);
            User user2 = new User();
            user2.setId("2l");
            user2.setName("scott");
            user2.setAge(29);
            list.add(user2);
            return list;
        }
    
        @ApiOperation(value = "新增用户", notes = "根据用户实体创建用户")
        @ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User")
        @PostMapping("/add")
        public @ResponseBody Map<String, Object> addUser(@RequestBody User user) {
            Map<String, Object> map = new HashMap<>();
            map.put("result", "success");
            return map;
        }
    
        @ApiOperation(value = "删除用户", notes = "根据用户id删除用户")
        @ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "Long", paramType = "path")
        @DeleteMapping("/{id}")
        public @ResponseBody Map<String, Object> deleteUser(@PathVariable(value = "id") Long id) {
            Map<String, Object> map = new HashMap<>();
            map.put("result", "success");
            return map;
        }
    
        @ApiOperation(value = "更新用户", notes = "根据用户id更新用户")
        @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户id", required = true, dataType = "Long", paramType = "path"),
            @ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User") })
        @PutMapping("/{id}")
        public @ResponseBody Map<String, Object> updateUser(@PathVariable(value = "id") Long id, @RequestBody User user) {
            Map<String, Object> map = new HashMap<>();
            map.put("result", "success");
            return map;
        }
    
    }
    
    /**
     * 
     * 
     * Swagger常用注解
    @Api：修饰整个类，描述Controller的作用；
    @ApiOperation：描述一个类的一个方法，或者说一个接口；
    @ApiParam：单个参数描述；
    @ApiModel：用对象来接收参数；
    @ApiProperty：用对象接收参数时，描述对象的一个字段；
    @ApiResponse：HTTP响应其中1个描述；
    @ApiResponses：HTTP响应整体描述；
    @ApiIgnore：使用该注解忽略这个API；
    @ApiError ：发生错误返回的信息；
    @ApiImplicitParam：一个请求参数；
    @ApiImplicitParams：多个请求参数。
    编写RESTful API接口
    Spring Boot中包含了一些注解，对应于HTTP协议中的方法：
    @GetMapping对应HTTP中的GET方法；
    @PostMapping对应HTTP中的POST方法；
    @PutMapping对应HTTP中的PUT方法；
    @DeleteMapping对应HTTP中的DELETE方法；
    @PatchMapping对应HTTP中的PATCH方法。
    8**
    
    http://localhost:9000/swagger-ui.html
    **/

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gzNTYzNjM_size_16_color_FFFFFF_t_70]: /images/20210726/e2eb8c49c0b34b77bb9e24752432b797.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gzNTYzNjM_size_16_color_FFFFFF_t_70 1]: /images/20210726/a18d8fb551654cc3a56a153ee1c1e735.png