首页 > 其他分享 >knife4j——集成Swagger生成Api文档

knife4j——集成Swagger生成Api文档

时间:2023-09-15 20:45:20浏览次数:48  
标签:knife4j docket apiInfo 文档 registry Api Swagger Docket

  首先是依赖导入

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

   然后是配置文件中的配置


/**
 * 配置类,注册web层相关组件
 */
@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("接口文档标题")
                .version("2.0")//版本号
                .description("接口文档详细信息")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("填写要管理的包路径"))//一般管理controller包下的接口类
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {//addResourceHandlers为WebMvcConfigurationSupport类中的实现方法
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");//之后通过,访问地址/doc.html来访问端口测试页面
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

 

标签:knife4j,docket,apiInfo,文档,registry,Api,Swagger,Docket
From: https://www.cnblogs.com/cyknote/p/17705895.html

相关文章

  • Apipost你了解嘛?看这篇文章就够了
    在数字化时代,API已经成为了应用程序之间进行通信的关键桥梁。随着API的普及和复杂性的增加,API研发和管理也面临着越来越多的挑战。为了更好地应对这些挑战,Apipost提供了一整套API研发工具,包括API设计、API调试、API文档和API自动化测试等功能。本文将深入介绍Apipost的优势和特点,......
  • fastapi
    fastapiFastApi官网:https://fastapi.tiangolo.com/zh/-FastAPI是一个用于构建API的现代、快速(高性能)的web框架,使用Python3.6+并基于标准的Python类型提示。-可与NodeJS和Go并肩的极高性能(归功于Starlette和Pydantic)。最快的Pythonweb框架之一。#pip......
  • FastApi async函数一定比普通函数快吗,你是否有相同的问号
    FastAPI是一个用于构建API的现代、快速(高性能)的web框架,使用Python3.6+并基于标准的Python类型提示关键特性:快速:可与NodeJS和Go并肩的极高性能(归功于Starlette和Pydantic)。最快的Pythonweb框架之一。高效编码:提高功能开发速度约200%至300%。*更少......
  • Adding API Key Authentication to a FastAPI application
    https://joshdimella.com/blog/adding-api-key-auth-to-fast-apiStep1:DefineaListofValidAPIKeysAPI_KEYS=["9d207bf0-10f5-4d8f-a479-22ff5aeff8d1","f47d4a2c-24cf-4745-937e-620a5963c0b8","b7061546-75e8-444b-a2c4......
  • 【接口自动化测试】Eolink Apilkit 安装部署,支持 Windows、Mac、Linux 等系统
    EolinkApikit有三种客户端,可以依据自己的情况选择。三种客户端的数据是共用的,因此可以随时切换不同的客户端。我们推荐使用新推出的ApikitPC客户端,PC端拥有线上产品所有的功能,并且针对本地测试、自动化测试以及使用体验等方面进行了强化,可以提供最佳的使用感受。建议对......
  • uniapp VUE-H5页面微信公众号内使用微信JSAPI支付
    注意看本文主要讲解uniapp打包成h5页面并部署在公众号时使用JSAPI的微信支付问题前期准备工作.首先要有一个开通商户注册的公众号,我们需要他的appid;.其次要开通商户公众号的公众号支付的功能并添加域名,开通完成后就可以基本开始我们的开发了既然是jsapi开发自然是要引入的......
  • API接口知识小结
    应用程序接口API(ApplicationProgrammingInterface),是提供特定业务输出能力、连接不同系统的一种约定。这里包括外部系统与提供服务的系统(中后台系统)或后台不同系统之间的交互点。包括外部接口、内部接口,内部接口又包括:上层服务与下层服务接口、同级接口。如果不想被视为技术大佬眼......
  • API商品接口实现盈利
    在当今的数字化时代,电子商务应用程序已经成为人们日常生活的重要组成部分。为了满足用户对于便捷购物体验的需求,许多电商平台提供了API商品接口,允许开发者调用特定的功能,如商品查询、购物车管理、订单处理以及支付等。然而,如何通过这些API商品接口实现盈利,是许多电商平台和开发者共......
  • 高版本kube-apiserver删除namespace
    确认namespace下没有资源kubectlgetall-nmy-namespacekubectldeletenamespacemy-namespace调用kube-apiserverPUT接口去掉namespace中的finalizerkubectlproxy&PID=$!curl-H"Content-Type:application/json"-XPUT-d'{"apiVersion":"......
  • 个人微信API对接-Golang版本
    golang版个人微信号API,突破登录限制,类似开发公众号一样,开发个人微信号微信机器人......