springboot + swagger 实例代码

2019-11-26 12:21:15

字体：大中小

来源：转载

供稿：网友

swagger用于定义API文档。

好处：

前后端分离开发
API文档非常明确
测试的时候不需要再使用URL输入浏览器的方式来访问Controller
传统的输入URL的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件）
spring-boot与swagger的集成简单的一逼

1、项目结构

和上一节一样，没有改变。

2、pom.xml

引入了两个jar。

<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>

3、Application.java

package com.xxx.firstboot;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import springfox.documentation.swagger2.annotations.EnableSwagger2;@SpringBootApplication    //same as @Configuration+@EnableAutoConfiguration+@ComponentScan@EnableSwagger2       //启动swagger注解public class Application {  public static void main(String[] args) {    SpringApplication.run(Application.class, args);  }}

说明：

引入了一个注解@EnableSwagger2来启动swagger注解。（启动该注解使得用在controller中的swagger注解生效，覆盖的范围由@ComponentScan的配置来指定，这里默认指定为根路径"com.xxx.firstboot"下的所有controller）

4、UserController.java

package com.xxx.firstboot.web;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.RequestHeader;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController;import com.xxx.firstboot.domain.User;import com.xxx.firstboot.service.UserService;import io.swagger.annotations.Api;import io.swagger.annotations.ApiImplicitParam;import io.swagger.annotations.ApiImplicitParams;import io.swagger.annotations.ApiOperation;import io.swagger.annotations.ApiResponse;import io.swagger.annotations.ApiResponses;@RestController@RequestMapping("/user")@Api("userController相关api")public class UserController {  @Autowired  private UserService userService;  //  @Autowired//  private MyRedisTemplate myRedisTemplate;  @ApiOperation("获取用户信息")  @ApiImplicitParams({    @ApiImplicitParam(paramType="header",name="username",dataType="String",required=true,value="用户的姓名",defaultValue="zhaojigang"),    @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用户的密码",defaultValue="wangna")  })  @ApiResponses({    @ApiResponse(code=400,message="请求参数没填好"),    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")  })  @RequestMapping(value="/getUser",method=RequestMethod.GET)  public User getUser(@RequestHeader("username") String username, @RequestParam("password") String password) {    return userService.getUser(username,password);  }  //  @RequestMapping("/testJedisCluster")//  public User testJedisCluster(@RequestParam("username") String username){//    String value = myRedisTemplate.get(MyConstants.USER_FORWARD_CACHE_PREFIX, username);//    if(StringUtils.isBlank(value)){//      myRedisTemplate.set(MyConstants.USER_FORWARD_CACHE_PREFIX, username, JSON.toJSONString(getUser()));//      return null;//    }//    return JSON.parseObject(value, User.class);//  }  }

说明：
1、@Api：用在类上，说明该类的作用

2、@ApiOperation：用在方法上，说明方法的作用

3、@ApiImplicitParams：用在方法上包含一组参数说明

4、@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

1、paramType：参数放在哪个地方 header-->请求参数的获取：@RequestHeader

①query-->请求参数的获取：@RequestParam

② path（用于restful接口）-->请求参数的获取：@PathVariable

③body（不常用）

④ form（不常用）

2、name：参数名

3、dataType：参数类型

4、required：参数是否必须传