springboot使用swagger2实现restful风格

1.简介

（1）swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务；是一款Restful接口的文档在线自动生成和功能测试功能软件。

（2）restful

在平时的 Web 开发中，method 常用的值是 GET 和 POST，但是实际上，HTTP 方法还有 PATCH、DELETE、PUT 等其他值，这些方法又通常会匹配为如下的 CRUD 动作:

下面是普通的crud跟restful风格的crud的uri的区别 

2.实战

使用springboot+mybatis+swagger2写了一个简单的可以实现增删改查的小demo

1.在pom.xml文件中加入swagger2依赖

        <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.完成实体类、dao、service的编写

实体类（这里用了lombok插件）

package com.sxw.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Books {

    private int bookID;
    private String bookName;
    private int bookCounts;
    private String detail;

}

dao层

package com.sxw.dao;

import com.sxw.pojo.Books;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;

import java.util.List;
@Mapper
@Repository
public interface BookMapper {
    //增加一本书
    int addBook(Books books);
    //删除一本书
    int deleteBookById(@Param("bookID") int id);
    //更新一本书
    int updateBook(Books books);
    //查询一本书
    Books queryBookById(@Param("bookID") int id);
    //查询全部的书
    List<Books> queryAllBook();
    Books queryBookByName(@Param("bookName") String bookName);
}

mapper文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sxw.dao.BookMapper">

    <insert id="addBook" parameterType="Books" >
        insert into books (bookName,bookCounts,detail)
        values (#{bookName},#{bookCounts},#{detail});
    </insert>

    <delete id="deleteBookById" parameterType="int">
        delete from books where bookID=#{bookID}
    </delete>

    <update id="updateBook" parameterType="Books" >
        update books
        set bookName=#{bookName},bookCounts=#{bookCounts},detail=#{detail}
        where bookID=#{bookID} ;
    </update>

    <select id="queryBookById" parameterType="int" resultType="Books">
        select * from books
        where bookID=#{bookID};
    </select>

    <select id="queryAllBook" resultType="Books">
        select * from books;
    </select>

    <select id="queryBookByName" parameterType="String" resultType="Books">
        select * from books where bookName=#{bookName};
    </select>
</mapper>

service层

接口

package com.sxw.service;

import com.sxw.pojo.Books;

import java.util.List;

public interface BookService {

    //增加一本书
    int addBook(Books books);

    //删除一本书
    int deleteBookById(int id);

    //更新一本书
    int updateBook(Books books);

    //查询一本书
    Books queryBookById(int id);

    //查询全部的书
    List<Books> queryAllBook();

}

实现类

package com.sxw.service.impl;

import com.sxw.dao.BookMapper;
import com.sxw.pojo.Books;
import com.sxw.service.BookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class BookServiceImpl implements BookService {

    //service调dao层
    @Autowired
    private BookMapper bookMapper;

    public void setBookMapper(BookMapper bookMapper) {
        this.bookMapper = bookMapper;
    }

    public int addBook(Books books) {
        return bookMapper.addBook(books);
    }

    public int deleteBookById(int id) {
        return bookMapper.deleteBookById(id);
    }

    public int updateBook(Books books) {
        return bookMapper.updateBook(books);
    }

    public Books queryBookById(int id) {
        return bookMapper.queryBookById(id);
    }

    public List<Books> queryAllBook() {
        return bookMapper.queryAllBook();
    }

}

3.编写application.properties

# 关闭模板引擎缓存
spring.thymeleaf.cache=false

# 连接数据库
spring.datasource.username=root
spring.datasource.password=6666
spring.datasource.url=jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 前端显示乱码
server.servlet.encoding.force=true
server.servlet.encoding.charset=UTF-8
server.servlet.encoding.enabled=true
server.tomcat.uri-encoding=UTF-8

# 整合mybatis
mybatis.type-aliases-package=com.sxw.pojo
mybatis.mapper-locations=classpath:mapper/*.xml

#开启Mybatis下划线命名转驼峰命名
mybatis.configuration.map-underscore-to-camel-case=true

#开启HiddenHttpMethodFilter
spring.mvc.hiddenmethod.filter.enabled = true

4.创建一个swagger2配置类

package com.sxw.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 Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sxw.controller"))
                .paths(PathSelectors.any())
                .build();

    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot使用swagger2实现restful风格")
                .description("开心就完事了")
                .termsOfServiceUrl("https://www.baidu.com/")
                .contact(new Contact("wei","https://www.baidu.com/","1@qq.com"))
                .version("1.0")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .build();
    }

}

5.controller层

package com.sxw.controller;

import com.sxw.pojo.Books;
import com.sxw.service.BookService;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/books")
public class BookController {

    @Autowired
    private BookService bookService;

    //查询全部的书籍，并且返回到一个书籍展示页面
    @ApiOperation(value = "获取图书列表")
    @GetMapping
    public List<Books> list(){
        List<Books> list = bookService.queryAllBook();
        return list;
    }

    //查询单个书籍
    @ApiOperation(value = "查询单个书籍",notes = "根据bookID查询" )
    @ApiImplicitParam(name = "bookID", value = "图书ID", required = true, dataType = "int")
    @GetMapping("/{bookID}")
    public String queryById(@PathVariable("bookID") int id){
        Books books = bookService.queryBookById(id);
        if(books!=null){
            return books.toString();
        }
        return "没有查到此书";
    }

    //添加书籍的请求
    @ApiOperation(value="创建图书", notes="根据Books对象创建图书")
    @ApiImplicitParam(name = "books", value = "图书实体", required = true, dataType = "Books")
    @PostMapping
    public String addBook(@RequestBody  Books books){
        bookService.addBook(books);
        return "success";
    }


    //修改书籍
    @ApiOperation(value = "更新图书信息",notes = "跟新图书信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "bookID", value = "图书ID", required = true, dataType = "int"),
            @ApiImplicitParam(name = "books", value = "图书实体", required = true, dataType = "Books")
    })
    @PutMapping("/{bookID}")
    public String updateBook(@PathVariable int bookID,@RequestBody Books books){
        Books books1 = bookService.queryBookById(bookID);
        if(books1!=null){
            bookService.updateBook(books);
            return "success";
        }
        return "没有此用户 无法修改";
    }

    //删除书籍
    @ApiOperation(value = "删除图书",notes="根据url的id来指定删除图书")
    @ApiImplicitParam(name = "bookID", value = "图书ID", required = true, dataType = "int")
    @DeleteMapping("/{bookID}")
    public String deleteBook(@PathVariable("bookID") int id){
        Books books = bookService.queryBookById(id);
        if(books!=null){
            bookService.deleteBookById(id);
            return "删除成功";
        }
        return "没有此用户，删除失败";
    }

//    //查询书籍
//    @GetMapping(value = "/book")
//    public String queryBook(String queryBookName, Model model){
//        Books books = bookService.queryBookByName(queryBookName);
//        List<Books> list = new ArrayList<Books>();
//        list.add(books);
//        if(books==null){
//            list = bookService.queryAllBook();
//            model.addAttribute("error","未查到");
//        }
//        model.addAttribute("list",list);
//        return "book/list";
//    }
}

3.测试

在导航栏中输入http://localhost:8080/swagger-ui.html

我们接下来一个一个看，先看获取图书列表

后端代码

    //查询全部的书籍，并且返回到一个书籍展示页面
    @ApiOperation(value = "获取图书列表")
    @GetMapping
    public List<Books> list(){
        List<Books> list = bookService.queryAllBook();
        return list;
    }

用swagger测试

接下来测试单个查询

接下来增加书籍

在这里输入书籍信息即可

更改图书信息

删除图书

4.swagger2的一些注解使用说明

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
示例：
@Api(tags="APP用户注册Controller")

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"
示例：
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值
示例：
@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
})

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类
@ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")
@ApiResponses({
    @ApiResponse(code=400,message="请求参数没填好"),
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性
示例：
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{

    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;

    
}



POST请求传入对象 
示例：
   @ApiOperation(value="保存用户", notes="保存用户")
    @RequestMapping(value="/saveUser", method= RequestMethod.POST)
    public String saveUser(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){
        userDao.save(user);
        return "success!";
    }