SpringBoot整合swagger

1.将springfox-swagger2、springfox-swagger-ui导入pom.xml文件

       <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.编写SwaggerConfig.java配置文件

/**
 * @FileName: SwaggerConfig
 * @Author Steven
 * @Date: 2020/12/26
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    public ApiInfo apiInfo(){
        Contact contact=new Contact("steven","Contact contact","yinhaoye@qq.com");
        //作者信息
        return new ApiInfo("steven swagger2",
                "用户模块测试",
                "V1.0",
                "https://blog.csdn.net/SuperstarSteven",
                contact,"Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
                );
    }
}

3.编写实体类User.java

@ApiModel
@Data
public class User {

    @ApiModelProperty(value = "用户ID")
    private Long id;
    @ApiModelProperty(value = "用户名字")
    private String username;
    @ApiModelProperty(value = "用户密码")
    private String password;

4.编写UserController.java

/**
 * @FileName: UserController
 * @Author Steven
 * @Date: 2020/11/19
 */
@Api(tags = "用户接口",
        value = "/user",
        description = "用户接口测试",
        consumes = "123")
@RestController
@RequestMapping("/user")
public class UserController {
    private Logger logger=LoggerFactory.getLogger(this.getClass());

    @Autowired
    private UserService userService;

    @ApiOperation("新增用户")
    @PostMapping("/create")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用户名", defaultValue = "李四"),
    })
    public CommonResult create(@RequestBody User user){
        userService.create(user);
        return new CommonResult("操作成功",200);
    }

    @ApiOperation(value = "通过ID获取用户信息",notes = "通过ID获取用户信息",httpMethod ="GET")
    @GetMapping("/{id}")
    public CommonResult<User> getUser(@PathVariable Long id){
        User user = userService.getUser(id);
        logger.info("根据Id获取用户信息,用户名称为{}",user.getUsername());
        return new CommonResult<>(user);
    }
   @PostMapping("/update")
   public CommonResult update(@RequestBody User user){
       userService.update(user);
       return new CommonResult("操作成功",200);
   }
}

5.展示效果
在这里插入图片描述

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值