springboot集成swagger
大约 1 分钟SpringJavaSpring Boot
1、引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
2、开启注解
@EnableEurekaClient
@SpringBootApplication
@EnableSwagger2 //开启注解 (/swagger-ui.html )
public class SpringcloudLoginApplication {
public static void main(String[] args) {
SpringApplication.run(SpringcloudLoginApplication.class, args);
}
3、使用
package com.yl.springcloudlogin.controller;
import com.yl.springcloudlogin.entity.request.UserRegisterReq;
import com.yl.springcloudlogin.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
/**
* @Author 向往啊 2457081614@qq.com
* @Date 2019/07/18 23:33
* @Version 1.0
* @package com.yl.springcloudlogin.controller
*/
@Slf4j
@RestController
@RequestMapping(value = "/user")
@Api("用户相关接口")
public class UserController {
@Autowired
private UserService userService;
/**
*
* 登录接口
* @param account
* @param password
* @return
*/
@ApiOperation("用户登录接口")
@RequestMapping(value = "/login", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
public String login(@RequestParam("account") String account, @RequestParam("password") String password) {
return "login sucess";
}
@ApiOperation("用户注册接口")
@RequestMapping(value = "/register", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public String register(@RequestBody UserRegisterReq userRegisterReq) {
userService.registerUser(userRegisterReq);
return "注册成功";
}
}
备注:
- @Api:修饰整个类,描述Controller的作用
- @ApiOperation:描述一个类的一个方法,或者说一个接口
- @ApiParam:单个参数描述
- @ApiModel:用对象来接收参数
- @ApiProperty:用对象接收参数时,描述对象的一个字段
- @ApiResponse:HTTP响应其中1个描述
- @ApiResponses:HTTP响应整体描述
- @ApiIgnore:使用该注解忽略这个API
- @ApiError :发生错误返回的信息
- @ApiImplicitParam:一个请求参数
- @ApiImplicitParams:多个请求参数