抚顺建设网站,wordpress自适应淘宝客主题,做外贸那个网站比较好,包包17网站一起做网店Idea和Apipost结合使用 Idea 安装插件Apipost-Helper-2.0
在【file】–【settings】–【Plugins】搜索 “Apipost-Helper-2.0”–【install】#xff0c;重启Idea
编写controller接口
在idea中编写业务功能及接口之后#xff0c;在controller中鼠标【右键】单…
Idea和Apipost结合使用 Idea 安装插件Apipost-Helper-2.0
在【file】–【settings】–【Plugins】搜索 “Apipost-Helper-2.0”–【install】重启Idea
编写controller接口
在idea中编写业务功能及接口之后在controller中鼠标【右键】单击在弹出的快捷菜单中选择【Upload To ApiPost V2】在弹出的对话框中选择自己要发布接口的项目及路径如下图所示并点击【ok】右下角会弹出生成成功的提示如下图所示点击即可跳转也可以直接Apipost帐号对应的项目下的路径中就可以看到自己刚才发布的接口查看接口文档如果输入和输出字段描述不全时可以根据下面的步骤进行补齐保存即可。
请求参数 是否必填设置
请求参数必填项设置返回参数必填项设置
Header参数设置
参数描述列必填如下图所示
Query参数设置
参数描述列必填如下图所示预览效果如下图所示
Body参数设置
参数描述列必填在body中输入接口请求参数并点击【提取字段和描述】右侧会出现参数名、参数值、参数描述需要将参数描述的所有字段给中文描述方便前端开发人员联调的时候高效开发如果接口有更新新增、删除、修改字段需要及时更新接口文档如下图所示预览效果如下图所示 响应参数
在【调试】界面点击发送按钮在接口返回的实时响应中将响应结果复制在响应示例中粘贴进去然后点击右侧的【提取字段和描述】将字段描述信息列进行补齐。预览效果如下图所示
生成文档地址
在需要分享的目录上【右键】单击选择【分享目录】会弹出分享对话框如下图所示复制外网链接给到前端同事或者API接口文档上以后就一直用这个地址会根据接口文档实时更新文档内容不需要在修改接口文档之后重新分享。
【注意】也可以采用这种方式进行先设计接口文档接口设计好之后按接口文档进行开发提倡建议先设计接口文档然后在开发接口前端和后端可以同时进行达到高效协作目的。
