项目中怎么接入Swagger实现在线接口文档?
一. 前言
现在的项目开发很多都会采用前后端分离的模式,前端负责调用接口,进行渲染,前端和后端的唯一联系,就得是依靠API接口来完成。因此API接口文档就变得越来越重要。Swagger就是一个方便我们更好地编写API文档的框架,并且Swagger还可以模拟http请求调用。
二. Swagger使用步骤
废话少说,我们直接上使用教程。
1. 导入jar
2. 相关配置类
2.1 application.yml中增加配置
注意:一般在生产环境中不需要swagger,该值可以设置为false。
2.2 Swagger的配置类
配置类中需要使用@EnableOpenApi注解进行修饰。
2.3 swagger相关静态资源的映射处理
3. 接口调用
我们可以打开如下地址进行接口调用。
http://localhost:8010/doc.html
注意,http://localhost:8010/swagger-ui/index.html 无法使用,是由于knife4j-spring-boot-starter中排除了springfox-swagger-ui的jar包。如果我们想使用 http://localhost:8010/swagger-ui/index.html ,还需要额外导入一个jar包。
三. 设置接口文档的用户名和密码
出于安全考虑,我们在application.yml中,设置访问swagger时的用户名和密码。
相关推荐HOT
更多>>如何添加Java环境变量?
要添加Java环境变量,可以按照以下步骤:并安装Java开发工具包(JDK)、找到Java安装路径、设置JAVA_HOME环境变量、添加Java可执行文件路径到PATH...详情>>
2023-05-04 11:00:56从零开始学Java之String字符串的编码
对很多小白来说,可能不明白什么是字符编码,也不知道为什么要有字符编码,所以先来给大家简要地介绍一下字符编码。详情>>
2023-05-04 10:21:02新手速来!几步带你掌握MyBatis Plus
Mybatis-Plus(简称MP)是一款Mybatis的增强工具,它是在Mybatis的基础上实现的简化开发工具。Mybatis-Plus给我们提供了开箱即用的CRUD操作、自动...详情>>
2023-04-28 10:57:09学习java需要什么基础?基础知识有哪些?
网络编程:了解基本的网络编程概念和协议,熟悉 Java 网络编程 API。建议在学习 Java 之前,先学习一些基础的编程语言,如 C 或 Python 等,这...详情>>
2023-04-28 10:41:14