首页 > 编程语言 >【Java】java | swagger用法

【Java】java | swagger用法

时间:2022-11-25 11:06:09浏览次数:47  
标签:username password Java 示例 ApiImplicitParam 说明 注解 java swagger


一、说明

        1、备份下swagger用法

二、注解使用

1、用于Controller

1)注解

@Api(tags = "登录")

说明: 归类,即一级菜单

示例:

【Java】java | swagger用法_用户名


~~

2、用于请求

1)注解

@ApiOperation("账号密码登录")

说明:具体接口

3、用于请求参数

1)注解
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用户名,需RSA公钥加密",type = "String", required = true),
@ApiImplicitParam(name = "password", value = "密码,需RSA公钥加密", type = "String", required = true),
})
说明: 此注解,逐个描述;如果没有入参,则不需要注解

 4、忽略请求入参在文档显示

1)注解

@ApiIgnore

示例:

【Java】java | swagger用法_开发语言_02

说明:如果不忽略,文档就会限制LoginBody中的字段以及@ApiImplicitParam

说明:LoginBody包括了username,password,code,uuid,但这个接口只用到username,password

~~

5、用于结果响应

1)注解

@ApiResponses({
@ApiResponse(code = 200, message = "个人资料", response = UserInfoVo.class)
})

说明1: 主动指明返回的参数;为什么要这么做?因为外层是extendHashMap实现的,所以外层渲染报错,直接渲染业务参数

说明2:UserInfoVo也需要用@ApiModel与@ApiModelProperty

说明3:如果直接返回实体;不加@ApiResponses即可

示例图:

【Java】java | swagger用法_java_03

 

【Java】java | swagger用法_用户名_04

 

~~

 

标签:username,password,Java,示例,ApiImplicitParam,说明,注解,java,swagger
From: https://blog.51cto.com/u_15891242/5885727

相关文章

  • 【Java】java | springboot | 全局异常处理 | 拦截404
    一、说明        1、maven项目        2、springboot项目        3、走统一异常处理二、代码1、拦截4041)直接copy@ExceptionHandler(NoHandlerFoun......
  • 【Java】 java | linux | tomcat线程池配置 | tomcat性能调优
    一、说明        1、tomcat,一般用于传统的java项目,比如war包        2、tomcat,一般用的时候就是下载、解压、上传war包、启动tomcat        3、tom......
  • 【Java】java | minio | 安装minio
    一、说明        1、minio对象存储,玩一下二、Windows环境1、下载1、下载列表​​https://dl.min.io/server/minio/​​2、我用的版本​​https://dl.min.io/server/......
  • 【Java】 java | nacos | nacos使用注意事项
    一、说明        1、本文档总结nacos使用心得及日常遇到的问题        2、不涉及技术配置二、关于本地调试1、场景1:本地调试多个模块1)建议使用本地nacos2)......
  • Java学习
    分享学习一个技术的经验,Java的大体路线是JavaSE->JavaWeb->Spring->SSM整合(Spring+SpringMVC+myBatis)->SpringBoot->SpringCloud.要想到达最终的Springboo......
  • JAVA收录影记
    Controller层代码就该这么写,简洁又优雅描述了定义项目控制器时正确的打开方式,便于统一对请求参数、响应参数、异常做统一的处理,让控制器更多关注参数的接收和响应的返回......
  • Java并发编程学习13-任务取消(下)
    任务取消(下)《任务取消》由于篇幅较多,拆分了两篇来介绍各种实现取消和中断的机制,以及如何编写任务和服务,使它们能对取消请求做出响应。1.任务限时运行我们知道许多任务......
  • 如何用jQuery / Javascript播放二进制MP3流?
    我从ajax调用​中获得了纯二进制MP3流.没有标题,没有.只是直接MP3位.(实际上甚至连一条流都没有?)我希望能够在网页上播放它(如果可能的话,还可以提供下载).这可能吗?如果是......
  • 如何用jQuery / Javascript播放二进制MP3流?
    我从ajax调用中获得了纯二进制MP3流.没有标题,没有.只是直接MP3位.(实际上甚至连一条流都没有?)我希望能够在网页上播放它(如果可能的话,还可以提供下载).这可能吗?如果是这......
  • java-fianl关键字
    前言该篇文章讲了关于javafinal关键字的一些内容,大部分内容参考:https://www.cnblogs.com/dolphin0520/p/3736238.html概述final可以修饰:变量类方法fin......