swagger java api_Swagger 描述API返回信息

本文档介绍了如何在Java项目中使用Swagger2来构建API文档。首先在pom.xml中引入Swagger2的相关依赖,接着配置Swagger2信息,包括设置API信息、选择处理的API、定义全局响应消息。然后定义统一的返回格式ResultData,并使用@ApiModel和@ApiOperation注解为Controller和参数添加描述。最后展示了在UserController中如何使用这些注解来创建登录接口。
摘要由CSDN通过智能技术生成

一、pom中引入jar

2.8.0

io.springfox

springfox-swagger2

${swagger2.version}

io.springfox

springfox-swagger-ui

${swagger2.version}

二、配置swagger信息

@Configuration

@EnableSwagger2

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()

.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

.paths(Predicates.not(PathSelectors.regex("/error.*")))

.build()

.globalResponseMessage(RequestMethod.GET,

newArrayList(new ResponseMessageBuilder()

.code(500)

.message("系统繁忙!")

.build(),

new ResponseMessageBuilder()

.code(200)

.message("请求成功!")

.build()))

.globalResponseMessage(RequestMethod.POST,

newArrayList(new ResponseMessageBuilder()

.code(500)

.message("系统繁忙!")

.build(),

new ResponseMessageBuilder()

.code(200)

.message("请求成功!")

.build()))

.globalResponseMessage(RequestMethod.DELETE,

newArrayList(new ResponseMessageBuilder()

.code(500)

.message("系统繁忙!")

.build(),

new ResponseMessageBuilder()

.code(200)

.message("请求成功!")

.build()));

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("API接口文档")

.description("")

.termsOfServiceUrl("")

.version("1.0")

.build();

}

}

三、统一返回格式

@ApiModel(value = "返回说明")

public class ResultData{

@ApiModelProperty(value = "成功标识;true:成功;false:失败")

private boolean success;

@ApiModelProperty(value = "返回状态码;200:成功")

private String code;

@ApiModelProperty(value = "描述信息")

private String message;

private T data;

}

四、controller中使用注解

@Api(value = "登录接口")

public class UserController{

@ApiOperation(value = "登录", notes = "登录")

@PostMapping(value = "/doLogin")

public ResultData doLogin(LoginAppVo loginAppVo){

.....

}

}

五、vo中标注参数信息

@ApiModel

public class LoginAppVo{

@ApiModelProperty(value="用户名", required = true, dataType = "String")

private String userName;

@ApiModelProperty(value="用户密码", required = true, dataType = "String")

private String password;

}

结果:

e0a010d531e46998cafdf9bd18ff04a9.png

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值