第三章 springboot+swagger

 本文参考第四章 springboot + swagger（官网http://swagger.io/support/）

一、使用swagger优点：

• API文档清楚简明
• 为了测试简便，做到前后端分离
• spring-boot与swagger集成简单

二、项目结构与第二章 springboot+mybatis中的一致

引入swagger的jar：pom.xml

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

三、在WeiboApplication.java中加入@EnableSwagger2注解

package com.weibo2;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class WeiboApplication {

    public static void main(String[] args) {
        SpringApplication.run(WeiboApplication.class, args);
    }
}

说明：@EnableSwagger2用来启动Swagger,加入该注解使得用在controller中的swagger注解生效，覆盖的范围由@ComponentScan的配置来指定，

           这里默认指定为根路径"com.weibo2"下的所有controller）

四、WeiboController.java

package com.weibo2.controller;

import java.util.Date;

import org.springframework.beans.factory.annotation.Autowired;
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.weibo2.model.Weibo;
import com.weibo2.service.WeiboService;

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;

@Api("微博相关API")
@RestController
@RequestMapping("/weibo")
public class WeiboController {
    @Autowired
    private WeiboService weiboService;

    @ApiOperation("发表微博")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query", name = "content", value = "微博内容", dataType = "String", required = true),
            @ApiImplicitParam(paramType = "query", name = "owner", value = "发表者", dataType = "String", required = true) })
    @RequestMapping(value = "/addWeibo", method = RequestMethod.POST)
    @ApiResponses({ @ApiResponse(code = 400, message = "请求参数没填好"),
            @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对") })
    public boolean addWeibo(@RequestParam("content") String content, @RequestParam("owner") String owner) {
        Weibo weibo = new Weibo();
        weibo.setContent(content);
        weibo.setOwner(owner);
        weibo.setCreatetime(new Date());
        weibo.setLastmodifytime(new Date());
        weibo.setReadcount(0);
        return weiboService.addWeibo(weibo);
    }

    @ApiOperation("查询微博")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query", name = "id", value = "微博ID", dataType = "Integer", required = true) })
    @ApiResponses({ @ApiResponse(code = 400, message = "请求参数没填好"),
            @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对") })
    @RequestMapping(value = "/getWeibo", method = RequestMethod.GET)
    public Weibo getWeibo(@RequestParam("id") Integer id) {
        return weiboService.getWeibo(id);
    }

    @ApiOperation("更新微博")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query", name = "id", value = "微博ID", dataType = "Integer", required = true),
            @ApiImplicitParam(paramType = "query", name = "content", value = "微博内容", dataType = "String", required = false),
            @ApiImplicitParam(paramType = "query", name = "owner", value = "发表者", dataType = "String", required = false) })
    @ApiResponses({ @ApiResponse(code = 400, message = "请求参数没填好"),
            @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对") })
    @RequestMapping(value = "/updateWeibo", method = RequestMethod.PUT)
    public boolean updateWeibo(@RequestParam(value = "id", required = true) Integer id,
            @RequestParam(value = "content", required = false) String content,
            @RequestParam(value = "owner", required = false) String owner) {
        Weibo weibo = weiboService.getWeibo(id);
        weibo.setContent(content);
        weibo.setOwner(owner);
        return weiboService.updateWeibo(weibo);
    }

    @ApiOperation("删除微博")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query", name = "id", value = "微博ID", dataType = "String", required = true) })
    @ApiResponses({ @ApiResponse(code = 400, message = "请求参数没填好"),
            @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对") })
    @RequestMapping(value = "/deleteWeibo", method = RequestMethod.DELETE)
    public boolean deleteWeibo(@RequestParam("id") Integer id) {
        return weiboService.deleteWeibo(id);
    }
}

说明：

• @API:用于类上，使该类成为Swagger resource.eg:@Api(value = "/pet", description = "Operations about pets")
• @ApiOperation:用于方法上，描述方法作用

• @ApiOperation(value = "Finds Pets by status",
      notes = "Multiple status values can be provided with comma seperated strings",
      response = Pet.class,
      responseContainer = "List")
   public Response findPetsByStatus(...) { ... }

• @ApiResponses：用于表示一组响应
• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  • code：数字，例如400
  • message：信息，例如"请求参数没填好"
  • response：抛出异常的类

• @ApiImplicitParams：用于方法上，包含一组参数

• @ApiImplicitParam：用于@ApiImplicitParams中，具体说明参数
  • name：参数名
  • dataType：参数类型
  • required：参数是否必须传
  • value：参数的意思
  • defaultValue：参数的默认值
  • paramType-->参数位置
    • header-->请求头，请求参数的获取：@RequestHeader
    • query-->请求体，请求参数的获取：@RequestParam
    • path（用于restful接口）-->请求路径，请求参数的获取：@PathVariable
    • body（不常用）
    • form（不常用）

五、测试

在浏览器中输入：http://localhost:8080/swagger-ui.html

说明：

• 微博相关api-->@API
• 发表微博、删除微博。。-->@ApiOperation

• content(owner)-->@ApiImplicitParam

• 400-->@ApiResponse