JSD-2204-Knife4j框架-处理响应结果-Day07

最新推荐文章于 2024-06-25 09:15:04 发布

程序猿 Monkey

最新推荐文章于 2024-06-25 09:15:04 发布

阅读量1.2k

点赞数

文章标签： restful java spring

本文链接：https://blog.csdn.net/thenewsystrm/article/details/126107976

版权

本文档介绍了如何使用Knife4j框架生成并细化在线API文档，包括添加依赖、配置类以及控制器注解。同时，讨论了服务器响应客户端时应包含的业务状态码、描述文本和数据，并提出自定义类型进行封装，以及Spring MVC中的JSON转换。

摘要由CSDN通过智能技术生成

1.Knife4j框架

Knife4j框架是一款基于Swagger 2框架的、能够基于项目中的控制器的代码来生成在线API文档的框架，另外，此框架还有调试功能，可以向服务器端发送请求，并获取响应结果。

关于此框架，要使之能够使用，需要：

添加依赖
添加配置类
在application.properties中添加1条配置

关于依赖的代码：

<!-- Knife4j Spring Boot：在线API -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

关于配置类：

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * Knife4j配置类
 *
 * @author java@tedu.cn
 * @version 0.0.1
 */
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    /**
     * 【重要】指定Controller包路径
     */
    private String basePackage = "cn.tedu.csmall.product.controller";
    /**
     * 分组名称
     */
    private String groupName = "product";
    /**
     * 主机名
     */
    private String host = "http://java.tedu.cn";
    /**
     * 标题
     */
    private String title = "酷鲨商城在线API文档--商品管理";
    /**
     * 简介
     */
    private String description = "酷鲨商城在线API文档--商品管理";
    /*