web.rest.github 库模块帮助文档

调用示例

web.rest.github 成员列表 #

web.rest.github.getContent(用户名,仓库名,文件路径,分支名) #

自指定的 GitHub 仓库获取数据，分支名可省略

web.rest.github.getContent(网址) #

自指定的 GitHub 网址获取数据,
包含 blob,raw 的 GitHub 网址可省略域名部分

web.rest.github.getJson(用户名,仓库名,文件路径,分支名) #

自指定的 GitHub 仓库获取数据，分支名可省略。
成功返回解析 JSON 得到的对象。

web.rest.github.getJson(网址) #

自指定的 GitHub 网址获取 JSON 文件，成功返回解析 JSON 得到的对象。
包含 blob,raw 的 GitHub 网址可省略域名部分

web.rest.github.getZipUrl #

获取下载仓库的 zip 地址。

web.rest.github.getZipUrl(仓库网址) #

如果未指定参数 @2 则解析参数 @1 指定的 GitHub 网址。
包含 blob,raw 的 GitHub 网址可省略域名部分。
也可以简写为 用户名/项目名 格式（用户名不能包含冒号:与/）

web.rest.github.getZipUrl(搜索关键字) #

在 GitHub 上搜索仓库名，并返回搜索结果中的首个仓库的 zip 地址。
注意不能过于频繁地调用搜索接口。

web.rest.github.getZipUrl(用户名,仓库名) #

指定参数 @1,@2 则需要准确指定用户名与仓库名。

web.rest.github.import(网址) #

自指定的 GitHub 网址获取 *.aardio 扩展库文件代码并安装,
包含 blob,raw 的 GitHub 网址可省略域名部分,
仅支持小型单文件扩展库,
项目中的文件路径必须与库目录下的子路径一致

web.rest.github.latestRelease("用户名/仓库名") #

获取最新发布版本信息

如果参数@2指定文件名,或获取文件名的函数,
则返回该文件的完整下载地址

web.rest.github.parseUrl #

解析指定的 GitHub 网址

web.rest.github.parseUrl(用户名,仓库名,文件路径,分支名) #

如果指定了参数 @1 与 @2 则直接返回所有参数。
其他参数可选

web.rest.github.parseUrl(网址) #

如果未指定参数 @2 则解析指定的 GitHub 网址并返回：
用户名,仓库名,文件路径,分支名。

包含 blob,raw 的 GitHub 网址可省略域名部分。
也可以简写为 用户名/项目名 格式（用户名不能包含冒号:与/）

web.rest.github.repo #

获取仓库接口。
成功返回 api,user,repo,url 等 4 个值。
返回 api 是由 web.rest.github（web.rest.jsonLiteClient API）创建的 API 对象。
返回的 url 则是项目主页网址。

失败返回 null,错误信息。

调用返回对象的 getUrl 方法可获取找到的项目网址。

web.rest.github.repo() #

返回对象:webRestApiObject

web.rest.github.repo(仓库网址) #

如果未指定参数 @2 则解析参数 @1 指定的 GitHub 网址。
包含 blob,raw 的 GitHub 网址可省略域名部分。
也可以简写为 用户名/项目名 格式（用户名不能包含冒号:与/）

web.rest.github.repo(搜索关键字) #

在 GitHub 上搜索仓库名，并返回搜索结果中的首个仓库调用接口。
注意不能过于频繁地调用搜索接口。

web.rest.github.repo(用户名,仓库名) #

指定参数 @1,@2 则需要准确指定用户名与仓库名。

web.rest 成员列表 #

web.rest.github() #

创建 GitHub 接口客户端。
web.rest.github 继承自 web.rest.jsonLiteClient 对象。
使用 api 函数返回接口对象，不需要输入接口地址,

返回对象:webRestClientObject

Markdown 格式