Spring Boot入門系列（二十二）使用Swagger2構(gòu)建RESTful API文檔

<!-- swagger2 依賴配置--><dependency>    <groupId>io.springfox</groupId>    <artifactId>springfox-swagger2</artifactId>    <version>2.8.0</version></dependency><dependency>    <groupId>io.springfox</groupId>    <artifactId>springfox-swagger-ui</artifactId>    <version>2.8.0</version></dependency>

package com.weiz.config;
import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration@EnableSwagger2public class Swagger2Config implements WebMvcConfigurer {    @Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.weiz.controller"))                .paths(PathSelectors.any())                .build();    }
    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")                .description("Spring Boot相關(guān)文章請關(guān)注：https://www.cnblogs.com/zhangweizhong")                .termsOfServiceUrl("https://www.cnblogs.com/zhangweizhong")                .contact("架構(gòu)師精進")                .version("1.0")                .build();    }
    /**     *  swagger增加url映射     * @param registry     */    @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("swagger-ui.html")                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")                .addResourceLocations("classpath:/META-INF/resources/webjars/");    }}

package com.weiz.controller;
import com.weiz.pojo.SysUser;import com.weiz.service.UserService;import com.weiz.utils.JSONResult;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.n3r.idworker.Sid;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.*;
@Api(tags = {"用戶接口"})@RestController@RequestMapping("/")public class UserController {
    @Autowired    private UserService userService;
    @Autowired    private Sid sid;
    @ApiOperation(value="創(chuàng)建用戶", notes="根據(jù)User對象創(chuàng)建用戶")    @PostMapping(value = "user")    public JSONResult create(@RequestBody SysUser user) throws Exception {        String userId = sid.nextShort();        user.setId(userId);        userService.saveUser(user);        return JSONResult.ok("保存成功");    }
    @ApiOperation(value="更新用戶詳細信息", notes="根據(jù)id來指定更新對象，并根據(jù)傳過來的user信息來更新用戶詳細信息")    @PutMapping(value = "user")    public JSONResult update(@RequestBody SysUser user) {        userService.updateUser(user);        return JSONResult.ok("保存成功");    }
    @ApiOperation(value="刪除用戶", notes="根據(jù)url的id來指定刪除對象")    @DeleteMapping("user/{userId}")    public JSONResult delete(@PathVariable String userId) {        userService.deleteUser(userId);        return JSONResult.ok("刪除成功");    }
    @ApiOperation(value="查詢用戶",notes = "通過用戶ID獲取用戶信息")    @GetMapping("user/{userId}")    public JSONResult queryUserById(@PathVariable String userId) {        return JSONResult.ok(userService.queryUserById(userId));    }}