当前位置:网站首页 > 技术博客 > 正文

swagger2 ui



Swagger2使用教程

Swagger 是一套基于 OpenAPI 规范(OpenAPI Specification,OAS)构建的开源工具,后来成为了 Open API 标准的主要定义者。对于 Rest API 来说很重要的一部分内容就是文档,Swagger 为我们提供了一套通过代码和注解自动生成文档的方法。

SpringBoot项目整合swagger需要用到两个依赖:springfox-swagger2和springfox-swagger-ui,用于自动生成swagger文档。

以下是一个配置类的使用简单示例:

注意: 对于需要实现swagger的开启与关闭,不要使用上述代码。对于生产环境,开启swagger可能会导致api暴露而产生的安全问题。并且要注意扫描包的位置更改。

在配置好swagger后,运行springboot项目,然后在浏览器打开,注意修改为自己的端口号。

在models下回显示api请求和使用到的类的信息。

在swagger ui页面可以进api的测试,如下图所示,点击想要测试的方法,然后点击try it out。

注意测试的方法需不需要参数,若需要参数则输入参数,然后点击execute。

然后即可在下方看到测试数据,如图所示

版权声明


相关文章:

  • 应用层协议包含哪些2025-09-05 21:01:05
  • linux什么桌面好2025-09-05 21:01:05
  • sql触发器怎么给出提示2025-09-05 21:01:05
  • 数据库mysql的使用2025-09-05 21:01:05
  • 深度优先遍历算法代码2025-09-05 21:01:05
  • linearlayout线性布局2025-09-05 21:01:05
  • 一句话木马图片2025-09-05 21:01:05
  • 数据库varchar和varchar22025-09-05 21:01:05
  • linux中的wait2025-09-05 21:01:05
  • echarts.apache2025-09-05 21:01:05