SpringBoot整合swagger_實現接口的定義的查看。

 

1.添加maven 依賴

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.1.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.1.1</version>
</dependency>

2. 添加項目配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.baidu.service"))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("項目api文檔")
                .description("項目api文檔")
                .termsOfServiceUrl("http://www.baidu.com")
                .version("1.0")
                .build();
    }


}

3. Api接口描述

@RestController
@CrossOrigin
@Api("用戶登陸接口")
public class LoginService extends BaseApiService<Object> {
    @Autowired
    private UserMapper userMapper;

    @PostMapping("/login")
    @ApiOperation(value = "登陸接口", notes = "用戶登陸")
    @ApiImplicitParams({@ApiImplicitParam(name = "mobile", value = "手機號碼", required = true,
            dataType = "String"), @ApiImplicitParam(name = "password", value = "用戶密碼", required = true,
            dataType = "String")})
    public BaseResponse<JSONObject> login(String mobile, String password) {
        String newPassword = MD5Util.MD5(password);
        UserEntity login = userMapper.login(mobile, newPassword);
        return login != null ? setResultSuccess("登陸成功") : setResultError("登陸失敗");
    }

}