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

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

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

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识堂,一个高原创,高收藏,有干货的微信公众号,一起成长,一起进步,欢迎关注

    推荐阅读
  • 身份证扫描件怎么在电脑上弄(身份证A4扫描件没有扫描仪怎么制作)

    拜托,现在都是技术时代了,制作个身份证A4扫描件没必要这么麻烦吧!你只负责按拍照按钮就行,裁剪与组合都是自动的。制作完成之后,还可以选择彩色还是黑白,因为这两个颜色在不同的平台提交资料可能要求都不一样。为了避免被盗用,还可以给扫描件添加水印,随便想加什么都可以。剩下的就是把它保存到相册或者导出成PDF使用就可以啦。

  • 芋头煮熟方法(香芋头如何煮做才好吃?)

    接下来我们就一起去了解一下吧!芋头煮熟方法将买回来的香芋头削掉皮,切成2厘米厚的块待用。铁锅洗净放入油烧热,然后倒入切成块的香芋加盐让油炸一下,时时翻动芋头块使它两面均匀受油炸过,几分钟后加水盖锅盖煮开。煮过十多分钟后打开锅盖用锅铲拌两拌,看芋头煮烂没有,烂了就熄火没熟透就接着煮。芋头煮熟透后撒入葱花末,翻拌几下就OK了出锅装碗。

  • 清理请勿关机要多久(关机清理一下)

    清理请勿关机主要根据手机清理的内存多少而定时间,这个没有具体的时间规定的,如果清理的内存较多的话,要比清理内存少的所用时间更久。

  • 博人和鸣人有什么不同(这些不同的都看出来了吗)

    接下来我们就一起去了解一下吧!博人和鸣人有什么不同博人希望父亲多关注自己,希望证明自己,而鸣人当上村长后天天各种忙,一心为村名,总是忽略了儿子的感受。博人是不自信,缺少鼓励,内心孤单,渴望父爱。鸣人是一心为人,重视团队利益,经常忽略了身边人的感受。

  • 西兰花用什么洗比较干净(我常用这3个办法清洗西兰花)

    我常用这3个办法清洗西兰花听说,关注“黑猫的厨房”的人,怎么吃都不会胖!说到清洗蔬菜,许多人都习惯把买回家的蔬菜直接浸泡在水中,而且一泡就是一两个小时甚至半天时间,总以为浸泡的时间越长,农药残留就去得越干净,其实这种方法并不科。

  • 咸菜腐竹猪肚汤怎么做(腐竹猪肚汤怎么做好喝)

    接下来我们就一起去了解一下吧!咸菜腐竹猪肚汤怎么做猪肚用热水冲洗,刮去表面的粘液,用油,生粉,盐反复抓洗4-5次,直到没有异味。清洗好的猪肚放开水里汆烫一下。把猪肚,洗干净的白果和薏米放入汤锅,注入适量的水烧开后转小火煲2.5小时。腐竹扳小段,用水泡软。把猪肚捞起来,放凉,切小条,根据个人的喜好,可以放回汤中与汤一起吃,也可以凉拌,热炒,一肚两吃。

  • 人教版五年级数学下册知识点汇总(人教版五年级数学)

    等边三角形绕中点旋转120度与原来重合。例:12是6的倍数,6是12的因数。也就是个位上是1、3、5、7、9的数。最小的质数是2,最小的合数是4,连续的两个质数是2、3。如果两数互质时,那么1就是它们的最大公因数。

  • 霍比特人和指环王的观影顺序(霍比特人和指环王的观影顺序是什么)

    霍比特人和指环王的观影顺序?我们一起去了解并探讨一下这个问题吧!想要了解中土世界的种族和基本构造的话,那就应该按照以下顺序:《指环王1》-《指环王2》-《指环王3》-《霍比特人1》-《霍比特人2》-《霍比特人3》。

  • 蒙犽逆风出什么装(你知道吗)

    蒙犽逆风出什么装大家都想知道蒙犽逆风出什么装,现在给大家普及一下。第一件装备冷静之靴,这个装备对于蒙犽来说可以增加其CD的减少,有助于打出连续伤害。第三件装备出无尽,增强蒙犽的暴力伤害,对于蒙犽来说是装备基本成型的象征。第四件装备选择影刃,这件装备可以大幅提升蒙犽的攻击速度,同时增强伤害,被动提升位移速度。第五件装备可以出破军,破军这件装备是一个画龙点睛的装备,对于射手来说可以增强输出伤害能力。