千锋教育-做有情怀、有良心、有品质的职业教育机构

400-811-9990
手机站
千锋教育

千锋学习站 | 随时随地免费学

千锋教育

扫一扫进入千锋手机站

领取全套视频
千锋教育

关注千锋学习站小程序
随时随地免费学习课程

上海
  • 北京
  • 郑州
  • 武汉
  • 成都
  • 西安
  • 沈阳
  • 广州
  • 南京
  • 深圳
  • 大连
  • 青岛
  • 杭州
  • 重庆
当前位置:重庆千锋IT培训  >  技术干货  >  项目中怎么接入Swagger实现在线接口文档?

项目中怎么接入Swagger实现在线接口文档?

来源:千锋教育
发布人:lxl
时间: 2023-02-24 14:34:16

  一. 前言

  现在的项目开发很多都会采用前后端分离的模式,前端负责调用接口,进行渲染,前端和后端的唯一联系,就得是依靠API接口来完成。因此API接口文档就变得越来越重要。Swagger就是一个方便我们更好地编写API文档的框架,并且Swagger还可以模拟http请求调用。

  二. Swagger使用步骤

  废话少说,我们直接上使用教程。

  1. 导入jar

项目中怎么接入Swagger

  2. 相关配置类

  2.1 application.yml中增加配置

项目中怎么接入Swagger

  注意:一般在生产环境中不需要swagger,该值可以设置为false。

  2.2 Swagger的配置类

  配置类中需要使用@EnableOpenApi注解进行修饰。

项目中怎么接入Swagger

项目中怎么接入Swagger

项目中怎么接入Swagger

  2.3 swagger相关静态资源的映射处理

项目中怎么接入Swagger

  3. 接口调用

  我们可以打开如下地址进行接口调用。

  http://localhost:8010/doc.html

f0f4aed7-2b11-446b-b1f2-953a481035a0

  注意,http://localhost:8010/swagger-ui/index.html 无法使用,是由于knife4j-spring-boot-starter中排除了springfox-swagger-ui的jar包。如果我们想使用 http://localhost:8010/swagger-ui/index.html ,还需要额外导入一个jar包。

项目中怎么接入Swagger

4587d8c8-09e6-4fb9-b821-9881a5c838c4

三. 设置接口文档的用户名和密码

  出于安全考虑,我们在application.yml中,设置访问swagger时的用户名和密码。

图片8


声明:本站稿件版权均属千锋教育所有,未经许可不得擅自转载。

猜你喜欢LIKE

java的输入语句—— Scanner类

2023-05-04

java数据库操作常识事务的四大特性

2023-05-04

DML数据操作之增加或删除数据

2023-05-04

最新文章NEW

socket是什么?有什么作用?

2023-05-04

Java常量定义是什么

2023-04-28

一分钟带你学多线程

2023-04-28

相关推荐HOT

更多>>

快速通道 更多>>

最新开班信息 更多>>

网友热搜 更多>>