Skip to content
孤峰 edited this page Oct 31, 2019 · 7 revisions

Quick start

安装插件

Preferences → Plugins → Marketplace → 搜索“Api Generator” → Install → Restart IDEA

开始使用

选择一个Controller类,将光标定位到方法区(方法名或者方法注释),点击鼠标右键,在弹出的菜单项里选择“Generate Api”。如图所示: 首次使用会弹窗提示输入必要配置,首先输入YApi服务器部署地址: 接着输入项目token: 点击OK,则插件会自动配置,然后自动生成文档并上传到YApi。上传成功后,IDE右下角会弹出提示框: 上传效果如图: 备注:token获取方法:登录yapi → 选择项目 → 设置 → token配置 → 点击复制按钮。如图:

解析规则

入参解析

响应解析

配置项

插件默认保存分类为api_generator,可以在配置项中修改默认分类, Preferences → Other Settings → Api Generator Setting → YApi Setting → Default save category,如图所示: 如果勾选了选项“Classify API automatically”,则插件会自动从类注释里抽取分类名,自动创建并保存。效果如下: 备注:每个项目只需配置一次,插件会自动持久化配置项,下次打开无需再次配置。

Clone this wiki locally