上一篇文章提到了API和SDK的区别,感觉大家都还挺感兴趣的,虽然没啥人评论,看的人也不多(心头痛中),由于工作的原因,经常要接触到接口,一般接口文档编写完毕,接下来开始写调用接口的代码,我的公司(据我所知很多企业也这样)采用sdk文档的形式来调用接口。使用的过程中----上次说到的eolinker提供一键化生成sdk文档,在接口编辑完后,可一键生成sdk文档,不用重复造轮子。不过使用过程还是有点小技巧的,今天来分享生成SDK文档。而具体的教程自己去官网看看哈。
首先要开启“生成sdk”插件,进入项目,点击“sdk生成”选项
然后点击创建方案,填入方案名称、设置环境信息(此处填入请求前置URI、请求头及全局变量信息),若项目已有环境,可直接选中相关环境。个人觉得这步很关键,填写设置后也方便后续查看和修改。再自定义环境和选中相关环境。填入分组类名,此处填入的分组类名将作为sdk的类名,故要求类名为英文,填完后保存。(为求简洁,我一般的做法是拼音拼写,大家可以自己选自己喜欢的命名方式),由于eolinker上支持二级分组,故可选择子分组类名是否继承父分组类名,打勾后子类名将话加上父分组类名。
最后点击生成sdk,选择语言,sdk文档便被一键化生成了,Sdk压缩包内容和自动生成的sdk文档内容,再调用直接在index.php调用即可。
以上就是本篇文章【一键化生成sdk文档的妙法】的全部内容了,欢迎阅览 ! 文章地址:http://xiaoguoguo.dbeile.cn/news/1022.html 资讯 企业新闻 行情 企业黄页 同类资讯 首页 网站地图 返回首页 多贝乐移动站 http://xiaoguoguo.dbeile.cn/mobile/ , 查看更多