导入YApi接口并通过swagger进行在线接口调试

本文介绍了如何导入YApi的JSON文件生成接口文档,并利用Swagger的knife4j框架进行接口调试。在Maven项目中配置knife4j,通过localhost:8080/doc.html访问接口文档。强调了YApi适用于设计阶段的接口管理和Swagger适用于开发阶段的接口调试。重点讲解了YApi的相关注解,如@Api、@ApiModel和@ApiOperation等。
摘要由CSDN通过智能技术生成

yapi网址 yapi.pro

导入json文件之后就可以生成接口文档.

导入swagger的框架knife4j

1.导入maven坐标

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

2.在配置类中加入knife4j相关配置,其通过反射解析并生成接口文档

@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("com.sky.controller"))
            .paths(PathSelectors.any())
            .build();
    return docket;
}

3.设置静态资源映射.

/**
 * 设置静态资源映射
 * @param registry
 */
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    regi
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值