Welcome to the yapi wiki!

一,插件安装

1，工程目录下载jar包yapiUploadPlus.jar
2，如果是下载的jar 需要 打开idea preferneces->plugins-> install plugin from disk,导入jar 包后(install)，重启
3，配置信息 
 idea: File | Settings | Other Settings | YApiUploadPlus

请求地址：yapi域名

项目id: 查看url 中project 后面的数字为项目id 下面地址的72 （http://127.0.0.1:3000/project/72/interface/api）

项目token: 打开yapi ->具体项目->设置->token 配置

tag:

status:接口状态（已完成、未完成）

请求类型:接口类型（dubbo/http）

二：使用方式

==1，==http项目====

    选中controller 类中的方法名称或类名（要选中方法名称，或类名，选中类名为当前类所有接口都上传），鼠标右击上传到yapi

2，dubbo接口 选中dubbo interface 接口类或者方法鼠标右键选择上传到yapi

三：文档生成规则

  自动识别接口中的注解，通过配置yapi中项目的相关参数，生成文档到yapi中

1，定义接口分类

  通过在方法或类注释中加 @menu 注释实现，优先级 方法>类>package 下面或者上面的@menu,如果没有自定义 默认为tool-tmp
     /**
       * @version V1.0
       * @description
       * @menu 测试Yapi接口
     **/
   @Slf4j
   @RestController
   @AllArgsConstructor
   public class TestController {
    }
      定义接口名称    方法名前增加注释  比如查询用户信息

        /**
 * 查询用户信息
 * @param userParam
 * @return
 */
@PostMapping("/queryUserInfo")
@LoginNotCheck
public Result queryUserInfo(@RequestBody UserParam userParam) {
    return null;
}

2，生成属性备注

  javabean字段添加注释
     /**
  * name:产品id
  * length:20
  */
private Long productId;
/**
  * name:产品版本id
  * length:20
  */
private Long productVersionId;

3，设置字段是否必须

GET请求 required = false

@RequestMapping(value = "/test", method = RequestMethod.GET)
@ResponseBody
public Object test(@RequestParam(value = "name",required = false) String name) {
 }

POST请求 javabean字段加@NotNull注解

     /**
  * name:产品id
  * length:20
  */
@NotNull(message = "productId不能为空")
private Long productId;