knife4j用法

引入依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.8</version>
    </dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-core</artifactId>
    <version>3.0.0</version>
    <scope>compile</scope>
</dependency>

配置类SwaggerConfig

package com.ruoyi.hsoutinterface.config;

import org.springframework.beans.factory.annotation.Value;
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;

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    @Value("${swagger.enabled}")
    private boolean enable = true;

    @Bean(value = "api")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .enable(enable)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("hs1.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.ruoyi.web.controller.hsoutinterface"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    /**
     * @Description: 构建 api文档的信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("恒实信用对外接口文档")
                // 设置联系人
                .contact(new Contact("fengqing", "https://www.abc.com/","888888@qq.com"))
                // 描述
                .description("controller层接口如下")
                // 定义版本号
                .version("1.0").build();
    }

}

实体类的注解和swagger2的一样

package com.ruoyi.hsoutinterface.domain;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import com.ruoyi.common.annotation.Excel;
import com.ruoyi.common.core.domain.BaseEntity;

/**
 * @author luheng
 * @date 2024-03-25
 */
@ApiModel(value = "个人信息")
public class Vatarrears
{
    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "主键", example = "测试值")
    private String fId;


    @ApiModelProperty(value = "企业信用代码", example = "测试值")
    private String taxpayerId;

   
}

浏览器访问接口文档

http://localhost:端口号/doc.html

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
使用Knife4j来生成API接口文档需要以下步骤: 1. 引入Knife4j依赖 在pom.xml中添加以下依赖: ```xml <!--Knife4j--> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>${knife4j.version}</version> </dependency> ``` 2. 配置Knife4j 在application.yml中添加以下配置: ```yaml knife4j: version: 2.0.2 title: 接口文档 description: 接口文档描述 contact: name: xxx url: https://xxx.com email: xxx@xxx.com license: name: Apache License 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfServiceUrl: https://xxx.com/terms-of-service.html ``` 其中,version为Knife4j的版本号,title为文档标题,description为文档描述,contact为联系人信息,license为许可证信息,termsOfServiceUrl为服务条款链接。 3. 编写接口文档注解 在接口方法上添加接口文档注解,例如: ```java @ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息") @ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "Long", paramType = "path") @GetMapping("/{userId}") public UserInfo getUserInfo(@PathVariable Long userId) { //... } ``` 其中,@ApiOperation为方法级别注解,用于描述接口信息,包括value、notes等属性;@ApiImplicitParam为方法参数级别注解,用于描述参数信息,包括name、value、required、dataType等属性。 4. 访问接口文档 启动应用程序后,在浏览器中访问如下地址即可查看生成的API接口文档: ``` http://localhost:port/doc.html ``` 其中,port为应用程序启动的端口号。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值