科百科
当前位置: 首页 范文大全

swagger接口顺序(用了Swagger2后接口设计文档)

时间:2023-05-31 作者: 小编 阅读量: 4 栏目名: 范文大全

pom文件加入如下依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.6.1</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-s

pom文件加入如下依赖

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

启动类上加入@EnableSwagger2注解

@EnableSwagger2@SpringBootApplication@MapperScan("com.st.blog.dao")public class BlogApplication {public static void main(String[] args) {SpringApplication.run(BlogApplication.class, args);}}

增加配置类

访问http://localhost:8080/swagger-ui.html

取其中一个例子,示例返回以及要填的各种参数都已经帮你弄好了,直接填入参数就能测试,非常方便

导出文档

可以将测试页面导出为各种格式的文档,不再介绍

Swagger注解

可以用Swagger提供的注解,对显示在页面的上的各种参数进行描述,和代码耦合性比较高,不再演示

@Api:修饰整个类,描述Controller的作用

@ApiOperation:描述一个类的一个方法,或者说一个接口

@ApiParam:单个参数描述

@ApiModel:用对象来接收参数

@ApiProperty:用对象接收参数时,描述对象的一个字段

@ApiResponse:HTTP响应其中1个描述

@ApiResponses:HTTP响应整体描述

@ApiIgnore:使用该注解忽略这个API

@ApiError :发生错误返回的信息

@ApiImplicitParam:一个请求参数

@ApiImplicitParams:多个请求参数

本文为小编原创文章,首发于Java识堂,一个高原创,高收藏,有干货的微信公众号,一起成长,一起进步,欢迎关注

    推荐阅读
  • 贵州茂兰自然保护城(茂兰保护区开启贵州首个森林生态系统大样地生物多样性调查)

    大样地调查现场。贵州茂兰国家级自然保护区管理局供图据悉,该森林生态系统大样地按国际标准建设,总面积25公顷,建于中国南方喀斯特世界自然遗产地、国际人与生物圈保护区网络贵州茂兰国家级自然保护区内。贵州茂兰国家级自然保护区管理局供图进一步的本底深入调查将在年后,尤其春暖花开、生物繁盛季节继续开展。预计在“十四五”期间完成大样地全部生物多样性及其环境本底的调查摸底和建档工作。

  • 威海荣成市要做几次核酸检测(威海荣成核酸检查在哪里做)

    未完成规定次数核酸检测的市民立即报备,否则将影响您的出行、生活和工作。请广大市民提醒身边的亲人、朋友、邻居主动报备检测。全市仍属防范区,疫情并没有结束,防疫切莫松懈大意,请您主动配合全市分级分区管控工作,少出门、不聚集、“两点一线”生产生活,全程接种疫苗,非必要不离荣,非必要不离威。让我们共同珍惜防控成果,齐心防疫,静候花开!

  • 山姆会员卡怎么办理(怎么办理山姆会员卡)

    跟着小编一起来看一看吧!山姆会员卡怎么办理首先个人用户可以亲临山姆会员商店办理。需要携带本人身份证或者有效证件,可以申请一张主卡,并可免费获得亲友卡一张。另外也可以登录山姆会员网上商店,在线办理。其次商业会籍,山姆可以提供上门办理服务,需要准备好有效的营业执照。另外依法成立的机构,团体也可申请商业会籍。山姆会员卡需要缴纳年费260元。

  • 会计中级职称怎么考的(中级会计职称考试时间)

    会计中级职称怎么考的会计专业技术中级资格考试设《财务管理》、《经济法》、《中级会计实务》三个科目。《经济法》科目:单项选择题、多项选择题、判断题、简答题、综合题。中级会计资格考试每门满分100分,各科考试成绩合格标准均以考试年度当年标准确定,一般为60分及格。中级会计考试时间为9月4日-6日,中级会计考试科目为中级会计实务、财务管理以及经济法。

  • 如何用solidworks画立体图(用SolidWorks画貌似莫比乌斯)

    建模步骤1.画三角形。6.特征:镜像1;方向:蓝色边线;参考到:绿色顶点,偏移距离:20;数量:8个。

  • 怎么查交了多少年社保(如何查交了多少年社保)

    以下内容希望对你有帮助!怎么查交了多少年社保登录自己所在地劳动与社会保障网站,找到个人查询,点击进入。输入身份证号及密码进入系统,首次登录密码为社保卡卡号。进入缴费信息查询界面后就可查看自己历年来缴费情况及缴费日期。

  • 高以翔啥时宣布恋爱了(苦熬4年演到男一)

    台湾艺人高以翔今日惊传在大陆猝逝,年仅35岁,让许多两岸艺人和粉丝至今仍不敢置信。高以翔早期是因出席时尚派对和电视节目受到关注,1米93的高大挺拔外貌,立刻吸引关注。高以翔在该剧饰演男主角,与女主角之间迸出令人心动又心痛的火花,时而内敛沉稳,时而深情温柔,光靠眼神说话的自然演技,让不少观众拍手叫好,再创事业高峰。

  • 飞机被判赔14万元(发生了什么事让他)

    事件发生在去年2月17日,乘客陆某在安庆市天柱山机场登机过程中,向飞机扔了两枚一元的硬币,导致航班取消,全体旅客滞留机场。随后,陆某被警方行政拘留10天,并被航空公司起诉到法院。近日,法院经过审理,判决陆某赔偿航空公司12万余元。对于扔硬币的动机,陆某表示是为了“祈福”。2019年4月,广西南宁,南航一航班,因乘客向机下投掷硬币延误。最终王某被处行政罚款200元。

  • 西游记95回概括200字(西游记95回概主要内容)

    西游记95回概括200字国王降旨,让唐僧师徒先去御花园安歇用斋。至婚日,悟空让唐僧应承婚事。悟空变成蜜蜂,飞入朝中,落在唐僧帽上。公主为妖邪所变,因敌不过悟空,钻入山洞,被悟空寻见。太阴星君称那是月宫中玉兔,将其带回。国王传旨绘下唐僧四人真容供养。该小说以“唐僧取经”这一历史事件为蓝本,通过作者的艺术加工,深刻地描绘了明代社会现实。

  • 油电混动车还用充电吗(问一个很弱智的问题)

    但是,由于受到成本的制约,混动车型的售价往往都比普通车型高出3~5万,而对于普通的劳动人民来说,接触的自然就少了。因此,很多人对混合动力车型都有一个问题——混动车需要充电吗?在这里,纪师傅可以很明确的告诉大家,混动车和纯电动车不同,它不需要充电。而且混动车型在使用的过程当中,不需要刻意的去调整驾驶模式,行车电脑会自动匹配最优的运行模式,以达到最佳的动力输出和燃油经济性。