涿州做网站公司,做网站head.htm,国办网站建设规范,taxonomy wordpress#x1f648;作者简介#xff1a;练习时长两年半的Java up主 #x1f649;个人主页#xff1a;程序员老茶 #x1f64a; ps:点赞#x1f44d;是免费的#xff0c;却可以让写博客的作者开心好久好久#x1f60e; #x1f4da;系列专栏#xff1a;Java全栈#xff0c;… 作者简介练习时长两年半的Java up主 个人主页程序员老茶 ps:点赞是免费的却可以让写博客的作者开心好久好久 系列专栏Java全栈计算机系列火速更新中 格言种一棵树最好的时间是十年前其次是现在 动动小手点个关注不迷路感谢宝子们一键三连 目录 课程名Java内容/作用知识点/设计/实验/作业/练习学习Java Spring Boot整合Swagger1. 添加依赖2. 创建Swagger配置类3. 访问Swagger UI页面 课程名Java
内容/作用知识点/设计/实验/作业/练习
学习Java
Spring Boot整合Swagger
Swagger是一款开源的API文档生成工具可以自动扫描项目中的接口并生成API文档。在Spring Boot项目中我们可以很方便地整合Swagger为我们的API接口生成详细的文档。本文将介绍如何在Spring Boot项目中整合Swagger。
1. 添加依赖
首先我们需要在项目的pom.xml文件中添加Swagger的依赖
dependencies!-- Swagger --!-- https://doc.xiaominfo.com/knife4j/documentation/get_start.html--dependencygroupIdcom.github.xiaoymin/groupIdartifactIdknife4j-spring-boot-starter/artifactIdversion3.0.3/version/dependency!-- 其他依赖 --
/dependencies2. 创建Swagger配置类
接下来我们需要创建一个Swagger配置类用于配置Swagger的相关参数。在这个类中我们将定义一个Docket实例用于配置API的基本信息、扫描路径等。同时我们还需要定义一个Bean方法用于返回Docket实例。代码如下
package com.jzj.scanner.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** description Knife4j 接口文档配置* https://doc.xiaominfo.com/knife4j/documentation/get_start.html* 访问地址http://localhost:8080/doc.html* author */
Configuration
EnableSwagger2
Profile({dev, test})
public class Knife4jConfig {Beanpublic Docket defaultApi2() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(new ApiInfoBuilder().title(接口文档).description(项目名称).version(1.0).build()).select()// 指定 Controller 扫描包路径.apis(RequestHandlerSelectors.basePackage(com.jzj.项目包名.controller)).paths(PathSelectors.any()).build();}
}3. 访问Swagger UI页面
最后我们可以启动项目并访问Swagger UI页面。默认情况下Swagger UI页面的地址为http://localhost:8080/doc.html。在这个页面上我们可以查看到项目中所有API接口的详细信息包括请求方式、参数、响应等信息。同时我们还可以通过页面上的“Try it out”按钮对API接口进行测试。
往期专栏Java全栈开发数据结构与算法计算机组成原理操作系统数据库系统物联网控制原理与技术
