前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Springboot整合knife4j配置swagger教程-干货

Springboot整合knife4j配置swagger教程-干货

作者头像
知识浅谈
发布2023-09-06 13:53:05
8720
发布2023-09-06 13:53:05
举报
文章被收录于专栏:分享学习

开启swagger文档,直接上教程。

第一步:引入依赖

代码语言:javascript
复制
    <!--swagger 依赖-->
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>3.0.3</version>
    </dependency>

第二步:添加配置文件

代码语言:javascript
复制
package com.test.empback.config;


import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author: 公众号:知识浅谈 个人微信:CYF2918CYF
 * Package:  com.test.empback.config
 * @date: 2023/9/3 15:40
 * @Description: swagger配置
 * @version: 1.0
 */
@Configuration
@EnableKnife4j
public class Knife4jConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.test.empback<这个地方改成你的包名>"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Springboot项目 后台服务API接口文档")
                .description("使用 knife4j 搭建的后台服务API接口文档")
                .contact(new Contact("你的姓名","你的网站","你的邮箱"))
                .version("1.0.0")
                .build();
    }
}

第三步:弄一个controller试试

代码语言:javascript
复制
@Api("公告相关控制器")
@RequestMapping("/")
public class TestController {
	@GetMapping("/test")
    public Result get(){
		return "test";
	}
}

然后运行项目: 打开网址 http://localhost:你设置的端口,没有设置默认为8080/api/doc.html

我的设置的8081,所以我就访问http://localhost:8081/api/doc.html

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2023-09-03,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 第一步:引入依赖
  • 第二步:添加配置文件
  • 第三步:弄一个controller试试
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档