Knife4j框架

Swagger是一个用于生成、描述和调用 RESTful 接口的 Web 服务，可生成项目的接口文档信息。
衍生出的Knife4j框架，可更方便的生成接口文档。

SpringBoot使用Knife4j依赖引入

<!--knife4j框架集成swagger接口文档--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.2</version></dependency>

配置文档信息
在配置类中写入注释
@EnableSwagger2 使用Swagger
@EnableKnife4j 使用Knife4j
在映射静态资源中映射接口文档的页面地址。doc.html是Knife4j自动生成的页面。
创建createRestApi扫描控制层，生成接口。

@Slf4j
@Configuration
//开启swagger文档功能
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {/*** 设置静态资源映射* @param registry*/@Overrideprotected void addResourceHandlers(ResourceHandlerRegistry registry) {log.info("开始进行静态资源映射...");//doc.html是Knife4j自动生成的接口文档页面registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");//静态资源registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");}@Beanpublic Docket createRestApi() {// 封装文档类型return new Docket(DocumentationType.SWAGGER_2)//添加描述信息.apiInfo(apiInfo()).select()//扫描控制层中所有接口.apis(RequestHandlerSelectors.basePackage("com.itheima.reggie.controller")).paths(PathSelectors.any()).build();}//描述文档信息private ApiInfo apiInfo() {return new ApiInfoBuilder().title("泥瓶巷陈平安接口文档").version("1.0").description("泥瓶巷陈平安接口文档").build();}}

-免拦截配置
如果有设置登录拦截，可使用以下路径开放接口文档路径。(没有设置登录拦截可不用，也可登录了再访问查看）

//放行接口文档页面"/doc.html","/webjars/**","/swagger-resources","/v2/api-docs"

项目启动后根据端口号直接访问页面
http://localhost:8080/doc.html

-doc.html

一键生成所有接口的文档 Swagger + springBoot相关推荐

可以一键生成crud的php框架,一键生成CRUD - FastAdmin框架文档 - FastAdmin开发文档
一键生成CRUD 最后更新时间:2021-01-05 19:54:10 在FastAdmin中可以快速的一键生成CRUD,其中包括控制器.模型.视图.验证器.语言包.JS. 准备工作在数据库中创建一 ...
自定义maven插件：自动生成API的word文档
继上次开发完Maven插件开发:根据库表生成实体类&根据实体类生成库表之后,博主对开发maven插件喜爱得一塌糊涂.这不,今天给大家带来了<自定义maven插件:自动生成API的word ...
作为参数给后端为空_后端 API 接口文档 Swagger 使用指南
前言作为一个以前后端分离为模式开发小组,我们每隔一段时间都进行这样一个场景:前端人员和后端开发在一起热烈的讨论"哎,你这参数又变了啊","接口怎么又请求不通了啊&quo ...
芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
Swagger接口在线文档
1.Swagger是什么? Swagger围绕OAS构建RESTFUL文档: Swagger动态生成接口定义文档: Swagger易用免费且开源: Swagger就是将项目中所有的接口展现在页面上,并 ...
接口文档Swagger、knife4j和YApi、APIDOC
接口文档Swagger.knife4j和YApi.APIDOC功能对比图 API文档工具简介特点跨语言在线编辑导入文档导出离线文档权限管理 Swagger spring-boot支持的基 ...
Spring Boot API 接口文档 Swagger 入门
转载自芋道 Spring Boot API 接口文档 Swagger 入门摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/Swagger/ 「芋道源码」欢迎转 ...
云信服务器代码,云信一键登录服务端API文档-一键登录-网易云信开发文档
一键登录 > 服务端 API 文档一键登陆服务端API文档接口概述 API调用说明本文档中,所有调用网易云信服务端接口的请求都需要按此规则校验. API checksum校验以下参数需要 ...
python使用微信设置-微信 python 接口 -- itchat 文档
itchat 一. 安装 $ pip install itchat 特殊的字典使用方式通过打印 itchat 的用户以及注册消息的参数, 可以发现这些值都是字典. 但实际上 itchat 精心构造了 ...

一键生成所有接口的文档 Swagger + springBoot

Knife4j框架

一键生成所有接口的文档 Swagger + springBoot相关推荐

最新文章

热门文章