Springboot集成Swagger2示例

Springboot集成Swagger2示例

注：当前文章意在使用，来自于网上摘抄。

Swagger2集成

在原有的springboot项目基础上集成swagger2

第一步

在pom文件中添加maven依赖：

<!--swagger库-->
<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>

第二步

创建swagger2配置类，代码如下（请主动修改包名等信息）

package com.swagger2.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里要改为自己项目包名
                .apis(RequestHandlerSelectors.basePackage("com.swagger2"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("在SpringBoot项目结合Swagger编写接口文档")
                .description("Swagger官方仓库https://github.com/swagger-api/swagger-ui")
                .build();
    }
}

第三步

在Application类顶部添加注解 @EnableSwagger2 加完如下：

package com.swagger2;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication(scanBasePackages = {"com.swagger2"})
@EnableSwagger2
public class Swagger2demoApplication {

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

}

第四步

在Controller类中编写接口注解内容
添加类注解：

@Api(value = "/test", tags = "用户信息接口模块")

添加请求方法注解：

@ApiOperation(value = "根据Id查询用户信息", notes = "根据Id查询用户信息,这里是详细说明")
@ApiImplicitParam(name = "id", value = "用户唯一id", required = true, dataType = "Long")

比如：

package com.swagger2.controller;

import com.swagger2.model.User;
import com.swagger2.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;

@Api(value = "/test", tags = "用户信息接口模块")
@RestController
@RequestMapping("/api")
public class UserController {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserController.class);

    @Autowired
    UserService userService;

    @ApiOperation(value = "根据Id查询用户信息", notes = "根据Id查询用户信息,这里是详细说明")
    @ApiImplicitParam(name = "id", value = "用户唯一id", required = true, dataType = "Long")
    @RequestMapping(value = "/user", params = "id", method = RequestMethod.GET)
    public User getUserById(@RequestParam Long id) {
        return userService.findById(id);
    }

    @ApiOperation(value = "根据Id添加用户信息", notes = "根据Id添加用户信息,这里是详细说明")
    @ApiImplicitParam(name = "id", value = "用户唯一id", required = true, dataType = "Long")
    @RequestMapping(value = "/user", params = "id", method = RequestMethod.POST)
    public User addUser(@RequestParam Long id) {
        return userService.addUser(id);
    }
    @ApiOperation(value="用户登录", notes="用户登录接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用户名", required = true ,dataType = "string"),
            @ApiImplicitParam(name = "password", value = "密码", required = true ,dataType = "string")
    })
    @RequestMapping(value = "/login", params = {"username", "password"}, method = RequestMethod.GET)
    public User tryLogin(@RequestParam String username, @RequestParam String password) {
        return userService.findByUserNameAndPassword(username, password);
    }

    @ApiOperation(value = "根据Id修改用户信息", notes = "根据Id修改用户信息,这里是详细说明")
    @ApiImplicitParam(name = "id", value = "用户唯一id", required = true, dataType = "Long")
    @RequestMapping(value = "/user", params = "id", method = RequestMethod.PUT)
    public User updateUser(@RequestParam Long id) {
        return userService.updateById(id);
    }

    @ApiOperation(value = "根据Id删除用户信息", notes = "根据Id删除用户信息,这里是详细说明")
    @ApiImplicitParam(name = "id", value = "用户唯一id", required = true, dataType = "Long")
    @RequestMapping(value = "/user", params = "id", method = RequestMethod.DELETE)
    public String deleteUser(@RequestParam Long id) {
        return userService.deleteById(id);
    }
}

最后，访问http://localhost:8080/swagger-ui.html 即可看到你的杰作

Swagger官方仓库: https://github.com/swagger-api/swagger-ui.