Swagger-UI与Spring Cloud整合与安全设置

·参数上添加

@RequestMapping(value = "/add", method = RequestMethod.POST)@ApiOperation(value = "添加用户", notes = "增加用户")public Result add( @ApiParam(name = "token", value = "token",required = true) @RequestParam(name = "token", required = true) String token, @ApiParam(name = "userName",value = "用户昵称",required = true) @RequestParam(name = "userName",required = true) String userName, @ApiParam(name = "mobile",value = "手机",required = true) @RequestParam(name = "mobile",required = true) String mobile) {

·展开bean对象参数

 public Ret simpleList(@Validated @ModelAttribute FileSimpleListDTO fileSimpleQueryDTO) {//..}

·忽略bean自定义参数说明显示

@ApiOperation(value = "更新员工信息", notes = "更新员工信息", response = SwaggerSimpleResultConstant.class)@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "主键ID", required = true, paramType = "path"), @ApiImplicitParam(name = "name", value = "姓名", required = true, paramType = "query")})@RequestMapping(value = "/{id}", method = { RequestMethod.PUT })public Map edit(@ApiIgnore Employee employee) {

·直接在bean中添加参数说明

@ApiModel(value = "用户信息")public class UserVo { @ApiModelProperty(value = "用户id", required = true) private long userId; @ApiModelProperty(value = "昵称", required = true) private long userName;

说明：

@ApiModel(value = “用户信息”) 解释实体bean

@ApiModelProperty(value = “用户id”, required = true) 解释属性

6、配置完成，访问API页面

http://localhost:服务端口/swagger-ui.html

7、整合spring Security实现访问API页面输入用户名密码

maven依赖：  org.springframework.boot  spring-boot-starter-security 配置文件添加：security.basic.path=/swagger-ui.htmlsecurity.basic.enabled=truesecurity.user.name=lovnxsecurity.user.password=123456

閱讀更多 JAVA小酷 的文章

關鍵字: 设置 整合 技术