一键化生成sdk文档的妙法

龚旺
• 阅读 3074

上一篇文章提到了API和SDK的区别,感觉大家都还挺感兴趣的,虽然没啥人评论,看的人也不多(心头痛中),由于工作的原因,经常要接触到接口,一般接口文档编写完毕,接下来开始写调用接口的代码,我的公司(据我所知很多企业也这样)采用sdk文档的形式来调用接口。使用的过程中----上次说到的eolinker提供一键化生成sdk文档,在接口编辑完后,可一键生成sdk文档,不用重复造轮子。不过使用过程还是有点小技巧的,今天来分享生成SDK文档。而具体的教程自己去官网看看哈。

首先要开启“生成sdk”插件,进入项目,点击“sdk生成”选项

一键化生成sdk文档的妙法

一键化生成sdk文档的妙法

然后点击创建方案,填入方案名称、设置环境信息(此处填入请求前置URI、请求头及全局变量信息),若项目已有环境,可直接选中相关环境。个人觉得这步很关键,填写设置后也方便后续查看和修改。再自定义环境和选中相关环境。填入分组类名,此处填入的分组类名将作为sdk的类名,故要求类名为英文,填完后保存。(为求简洁,我一般的做法是拼音拼写,大家可以自己选自己喜欢的命名方式),由于eoLinker上支持二级分组,故可选择子分组类名是否继承父分组类名,打勾后子类名将话加上父分组类名。

一键化生成sdk文档的妙法

一键化生成sdk文档的妙法

最后点击生成sdk,选择语言,sdk文档便被一键化生成了,Sdk压缩包内容和自动生成的sdk文档内容,再调用直接在index.php调用即可。

一键化生成sdk文档的妙法

一键化生成sdk文档的妙法

一键化生成sdk文档的妙法

小结:一键化自动生成sdk文档主要是不用再重新写调用代码,因为eoLinker生成的文档内容也还算详细,对于某些懒癌患者(我向天发4不是我)嫌麻烦,写多一行注释都觉得麻烦,啧啧哒。

点赞
收藏
评论区
推荐文章
Oracle 分组与拼接字符串同时使用
SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(
liam liam
3年前
5分钟打造好用好看API文档
5分钟打造好用好看API文档🤔️你是否遇到过这样的场景?对接第三方开放平台文档的时候,左手刷着接口文档看API,右手操作着接口调试工具🧱写完接口想交付或提供API文档给第三方使用,又觉得文档展示体验一般?很鸡肋?
Wesley13 Wesley13
4年前
C# 调用C++的dll 那些事
    之前从来没搞过C,最近被安排的任务需要调用C的接口,对于一个没用过Dependency的小白来说,原本以为像平时的Http接口那样,协议,端口一定义,方法参数一写就没事,结果踩了无数的坑。现在从0基础开始记录。A发了一个SDK文件夹过来,先不管cpp、h、lib五花八门的后缀文件,直接看文档说明,表明需要调哪些方法。网上简单的查阅下
Stella981 Stella981
4年前
Elasticsearch 5.5 入门必会之Java client(二)
前言由于本人一直从事Java方面研发,对Java也是尤其热爱,ES官方提供了Java的两种访问API的方式如下,当然,我选择了JavaAPI方式,因此我也开始了API踩坑之路(因为这个SDK文档看起来让人头痛,但是当我一步步理解深入的时候也发现挺简单的):JavaAPI\5.5\(https://www.oschin
Stella981 Stella981
4年前
Android Camera 相机开发详解
在Android5.0(SDK21)中,Google使用Camera2替代了Camera接口。Camera2在接口和架构上做了巨大的变动,但是基于众所周知的原因,我们还必须基于Android4.系统进行开发。本文介绍的是Camera接口开发及其使用方法,通过本文章,你将全面地学会Camera接口的开发流程。本图文与GitHubPages原
Stella981 Stella981
4年前
Android端穿山甲SDK集成
Android端穿山甲SDK集成SDK接入穿山甲平台上创建测试状态的应用ID和广告位ID(ps:测试集成完毕后再把应用及对应的代码位改成正式状态)(ps:应用ID和代码位ID是对应关系一个应用可以对应多个代码位ID)应用ID对应demo中的APPID
Easter79 Easter79
4年前
SpringBoot开发案例之整合Dubbo提供者(二)
!00.jpg(https://blog.52itstyle.com/usr/uploads/2017/07/1329278006.jpg)大家有没有注意到,上一篇中提供者,暴露接口的方式?混搭。springboot本身接口实现使用了注解的方式,而Dubbo暴露接口使用的是配置文件的实现方式,即如下:代码importorg.s
Stella981 Stella981
4年前
NVR硬件录像机web无插件播放方案功能实现之相关接口注意事项说明
该篇博文主要用来说明EasyNVR硬件录像回放版本的相关接口说明和调用的demo;方便用户的二次开发和集成。软件根目录会包含接口文档的,因此,本文主要是对一些特定接口的说明和接口实现功能的讲解以及部分demo的展示说明;对应接口说明;支持设备类型由于获取NVR录像机的相关功能是通过SDK来实现功能的,因此,
API 小达人 API 小达人
2年前
【遥遥领先】Eolink IDEA 插件:零代码入侵,自动生成接口
对于开发同学来说,无论是新增还是修改接口文档,都需要在开发工具和接口管理工具上同步最新的数据。而且接口文档变更内容会比较琐碎和频繁。那么是否有更轻便的同步接口数据方式呢?我们提供了一个高效方案:在开发工具上基于接口代码片段,一键生成API文档,支持在开发工具中调试,并可一键上传至EolinkApikit的代码仓库中。这样不仅可以减少界面的操作和系统间的切换,还可以在开发工具上完成琐碎和频繁的接口文档更新,是当前CODETOAPI的最佳实践。
API 小达人 API 小达人
2年前
「实用技巧」后端如何使用 Eolink Apikit 快速调试接口?
程序员最讨厌的两件事:1.写文档;别人不写文档。写文档、维护文档比较麻烦,而且费时,还会经常出现API更新了,但文档还是旧的,各种同步不一致的情况,从而耽搁彼此的时间,大多数开发人员不愿意写API文档。EolinkApikit为后端工程师提供API文档的创建与自动化生成、快速接口调试、以及API文档版本管理功能,协助后端工程师快速编写文档,调试接口,以及支持版本控制恢复历史记录。通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据Mock、接口测试就可以直接使用,无需再次定义。接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
陈杨 陈杨
7个月前
HarmonyOS5云服务技术分享--云存储SDK文章整理
在HarmonyOSArkTS应用中集成华为云存储SDK指南大家好呀!今天咱们来聊聊如何将华为云存储SDK集成到基于ArkTS(API911)的HarmonyOS应用中。这篇指南会手把手带你完成从环境准备到代码实现的完整流程,过程中遇到的常见问题也会贴心提