yapi创建项目

打开yapi，点创建项目

给项目取个名字，然后点击创建项目

创建成功之后可以看到项目还是空的

EasyYapi安装与配置

在Settings/Plugins中是搜索 EasyYapi ，直接安装

随后到Settings/Other Settings/EasyApi中，在Yapi配置栏下，输入server地址和token。

关于server地址：打开一个项目之后，url结构为 server地址/project/项目号/...

因此这里的server地址是url中 /project/项目号/... 之前的字符串。

token可以到项目界面下，设置/token配置 当中去复制。

导出接口文档

之后我们打开IDEA，在一个controller下，右键controller文件，或者右键点击编辑界面空白处，选择Export Yapi，第一次导出需要输入一次token，直接把刚刚复制的token复制进去即可。

导出成功：

可以看到我们导出的接口文档

可以看到注释比较乱

注释

之前yapi注释没有写好，重新规范一下注释，提高可读性。注释直接使用java原生注释即可，

我这里写了一个可以参考：

package org.sample.controller;

import org.sample.common.request.PageRequest;
import org.sample.common.response.Response;
import org.sample.common.response.ResponseGenerator;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;

/**
 * 测试模块
 * @author aaa
 * @since 2020/6/5 
 */
@RestController
public class HelloController {

    /**
     * 诗词朗诵接口
     * 打印字符串
     * @param id 用户id
     * @param pageRequest 分页请求
     * @return Response
     * @throws IOException
     */
    @RequestMapping("/say-hello")
    public Response sayHello(@RequestParam("id") String id, @RequestBody PageRequest pageRequest) throws IOException {
        Response response = ResponseGenerator.genSuccessResponse(pageRequest);
        return response;
    }
}

package org.sample.common.request;

import lombok.Data;
import lombok.EqualsAndHashCode;

import java.io.Serializable;

/**
 * 分页查询请求
 * @author aaa
 * @since 2022-06-01
 */
@Data
@EqualsAndHashCode
public class PageRequest implements Serializable {

    private static final long serialVersionUID = -3772068300449489722L;

    /**
     * 页码，默认是1
     */
    private Integer pageNo = 1;

    /**
     * 页大小，默认是10
     */
    private Integer pageSize = 10;

    /**
     * 消息是否已读，0-未读， 1-已读, null-未读+已读
     */
    private Integer read;
}

生成之后：

注意这里的创建人是与yapi账号绑定的，和代码注释的@author 无关

参考

https://www.cnblogs.com/allennote/articles/13154983.html

https://zhuanlan.zhihu.com/p/500965600

https://easyyapi.com/documents/java_doc_demo.html