当前位置:网站首页 > R语言数据分析 > 正文

swagger2配置登录(swagger2使用教程)



 swagger2是一款用于前后端分离的api文档生成工具,话不多说直接上教程。

1.第一步就是导入依赖;版本问题大家不要在意,会教大家一个忽略版本变化的方式。

 

2.编写一个helloController 

 

3.编写配置类,重点来了,忽略版本的方式就是看源码。其实里边啥也不用配就可以访问http://localhost:8080/swagger-ui.html 来查看了。简单测试一下发现可以访问继续配置。

 

我们点进去docket发现这些东西,再看一下ApiInfo里都写了什么,点进去就是Ctrl加鼠标左键

这就是默认的ApiInfo配置,那么这个DEFAULT_CONTACT,是啥呢,我们看这个类的最上边,

发现这个DEFAULT_CONTACT是这样配置的

配置扫描包,可以看到有这些配置,paths下边的就是一个过滤的根据情况自己配置即可,一般配置any();.enable()就是是否启动一般为true就可以,默认值为true,无需配置,这个一般用在生产环境和发布环境,在配置文件中配置值,然后引用

 

下边我编辑一个完整配置

 

完整测试一下: 可以看到现在下边的实体类不见了,只要我们的接口中返回值存在实体类就会在swagger2中出现

 简单编写一个方法在HelloController中,测试,models出现,

@ApiModel("用户实体类")对实体类注解就在文档中出现,

@ApiModelProperty("昵称")这个注解是对字段用的,

@ApiOperation("hello方法"):描述一个类的一个方法,是在controller类中定义的方法上使用

@ApiParam("用户名"):描述参数的作用

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

 

下边介绍一下swagger2最强大的功能在线测试,我们可以看到try it out 点击然后传入需要的参数,然后excute执行,就可以在线测试

如有错误请评论

 

 

 

 

 

 

 

 

 

到此这篇swagger2配置登录(swagger2使用教程)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!

版权声明


相关文章:

  • nlst命令(nls_instance_parameters)2025-03-20 22:27:09
  • imx6ull是arm几(imx6 arm)2025-03-20 22:27:09
  • xavier是什么牌子鞋子(xvwiv是什么鞋子)2025-03-20 22:27:09
  • Seatel流量套餐开通(cellcard流量套餐开通)2025-03-20 22:27:09
  • redhat认证多少钱(redhat报名)2025-03-20 22:27:09
  • 连接redis的软件(redis-cli连接)2025-03-20 22:27:09
  • 设置gridview单元格之间网格线的属性是(gridview单元格允许编辑)2025-03-20 22:27:09
  • 查看docker版本号命令(查看docker0)2025-03-20 22:27:09
  • grid布局兼容性(grid布局兼容ie)2025-03-20 22:27:09
  • linux目录重命名命令rename(linux目录命名规则)2025-03-20 22:27:09
  • 全屏图片