YapiQuickType插件使用说明

一、业务背景

日常开发中，我们会用到YApi这个工具，YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台，可以进行接口定义以及接口模拟的一些操作。

有关更多的YApi使用教程，可以参考YApi官网，这里就不再过多的赘述。

本插件是一个基于YApi开源接口之上的一个编码工具插件，主要用于接口定义实体代码的快速生成，只要在插件设置选项中进行简单的配置，即可一键快速生成多种你想要的语言接口定义实体代码。

目前支持生成的语言有：Kotlin、Java、TypeScript、Dart、Swift、Objective-C、Go、C++

二、插件下载以及配置

下载

可以直接去插件的开源地址下载Release版本，下载到本地之后IDE本地导入即可。
插件开源地址:https://github.com/RmondJone/YapiQuickType

你也可以直接插件市场搜索Yapi QuickType进行下载

插件配置

• YApi根路径填入自建的地址
• 配置你需要的项目的Id、Token
  这些都可以在YApi项目配置里找到，找到复制填入即可，项目名称可以随意填写。
• 重启IDE使配置生效
  

三、插件的使用以及效果

（1）插件的使用也非常简单，只需要在你想要生成代码的目录右键即可

(2) JSON代码生成插件：粘贴复制的JSON字符串、输入生成的实体名称、选择想要生成的语言点击OK生成代码

(3) YApi代码生成插件：选择你配置的项目的对应接口和想要生成的语言

（4）生成代码效果

注：IDE内部版本号低于203的使用FIX-IU171版本

如果请求QuickTypeNode服务失败，请配置以下host

172.67.196.35 quicktype.guohanlin.com

如果配置Host还是不行，你可以尝试本地搭建QuickTypeNode服务，然后服务地址配置到插件中即可 QuickTypeNode