Swift,RxSwift实现的GitHub API库

这是一个基于RxSwift的GitHub API库。希望给那些想写GitHub APP的同学一些方便。

RxGitHubAPI的整体设计

所有的返回都设计成对象。

例如用户,YYUser

仓库,YYRepository

tag,YYTag

等等……

还有很多对象,Issue,PullRequest请大家移步去clone项目看吧

所有的请求返回只有三种类型

1. Requestable

2. Pageable

3. Actionable

这三个全部都是符合Observable协议的类,也就是说它们是可以被订阅的。

下面从一个具体例子来解释下这三个类型的主要设计用途

1. 怎么样获取一个用户?

2. 获取到了这个用户实例,怎么样获取他的所有仓库?

3. 获取到了所有仓库,怎么样给其中的一个仓库star?

Requestable

这是一个符合Observable协议的类,它是一个泛型类,且泛类型必须符合NSObject协议。之所有这样是因为本库JSON解析成模型用的是MJExtension。整个工程就这一个库是OC写的。也许有时间会换成Swift的解析库

这个类主要是实现 请求 返回结果(错误或者正确)。当你订阅这个类实例的时候,它就会去网络请求,并且返回结果你订阅者

具体例子,根据一个用户名获取这个用户的详细信息

RxGitHubAPI.yy_user("tangqiaoboy").subscribe { (user) -> Void in           

       switch user{            case .Next(let user):                print(user.login)            case.Completed:                print("completed")            case .Error:                print("error")            }        }   

//下面是控制台输出   

tangqiaoboy

completed

完美!

看看这个

RxGitHubAPI.yy_userstatic func yy_user(username:String)->Requestable{        return Requestable(mothod: .GET, url: kUserURL(username))    }       

短短几行代码。返回的是Requestable对象,泛型在这里是是YYUser。YYUser就是RxGitHubAPI里表示一个用户信息的对象模型

Pageable

这是一个符合Observable协议的类,它是一个泛型类,且泛类型必须符合_ArrayType协议,且成员必须符合NSObject协议。因为这是提供给那些返回数组的API使用的,所有它的泛型必须符合数组,这样才能给订阅者提供想要的类型。这个类主要实现 请求  返回结果(错误或者正确)  翻页当你订阅这个类的时候,他就会去网络请求,并且返回结果给订阅者。当你想翻页的时候,你可以对Pageable进行nextPage操作

具体例子,就拿上面那个例子来说。在上面我们不是获取到了一个tangqiaoboy用户的对象模型YYUser嘛。假设我们现在持有这个YYUser的实例,就叫tangQiaoUser.我们来看看怎么获取这个tangqiaoUser的所有public仓库。

RxGitHubAPI.yy_user("tangqiaoboy").subscribe { (user) -> Void in            switch user{            case .Next(let user): print(user.login)               

//获取到了tangqiao用户                //获取这个用户的所有公开仓库                user.yy_repos.subscribeNext({ (repos) -> Void in                   

for repo in repos{  print(repo.full_name)} })           

case.Completed:print("completed")           

case .Error:print("error") }        }           

//控制台输出如下    tangqiaoboy/AVFoundationDemotangqiaoboy/ClassNote-iOStangqiaoboy/DocSets-for-iOStangqiaoboy/DoubanAlbumtangqiaoboy/ELCImageGrabbertangqiaoboy/ELCImagePickerControllertangqiaoboy/FlurryUsageSampletangqiaoboy/FmdbSampletangqiaoboy/HashTesttangqiaoboy/Hello-Worldtangqiaoboy/iOS-Protangqiaoboy/iOS-QR-Code-Generatortangqiaoboy/iOS5ViewCtrlerSampletangqiaoboy/iOSBlogCNtangqiaoboy/iOSSFtangqiaoboy/iphone-apptangqiaoboy/iRubytangqiaoboy/juzhaitangqiaoboy/KVO_Sampletangqiaoboy/LTBlacklisttangqiaoboy/MultiLayerNavigationtangqiaoboy/newsyctangqiaoboy/octopresstangqiaoboy/quotation.github.iotangqiaoboy/Ready2Rocktangqiaoboy/spf13-vimtangqiaoboy/SynchronizedUIActionSheetDemotangqiaoboy/tangqiaoboy.github.comtangqiaoboy/the-swift-programming-language-in-chinesetangqiaoboy/TopWindowSample

是不是超简单??这里默认的是第一页,每页三十条,当然了,你可以通过下面的方法给改变页数,或者每页的条数。

//获取到了tangqiao用户                //获取这个用户的所有公开仓库                user.yy_repos.page(2, per_page: 1).subscribeNext({ (repos) -> Void in                    for repo in repos{                        print(repo.full_name)                    }                })               

简单到令人发指!!!!

Actionable

这个类其实就是为了处理那些返回Bool的请求。

直接上例子吧。还是接着上面的。现在我有了tangqiaoboy的仓库模型YYRepository的实例,我想star。怎么star??

下面对刚刚获取的仓库列表的第一个进行star!简单:

RxGitHubAPI.yy_user("tangqiaoboy").subscribe { (user) -> Void in

switch user{

case .Next(let user):print(user.login)

//获取到了tangqiao用户

//获取这个用户的所有公开仓库

user.yy_repos.page(2, per_page: 1).subscribeNext({ (repos) -> Void in

repos[0].action_star.subscribeNext({ (isSuccess) -> Void in

if isSuccess{print("您关注成功啦!") } }) })

case.Completed:print("completed")

case .Error:print("error") } }

是不是很简单方便??还有很多工作为完成,后面的开发估计要等到年后了。大家没事就手贱star吧!给我点动力哈!!

具体怎么使用,提供哪些功能,欢迎大家去GitHub查看GitHub地址

也欢迎大家去新浪微博 给我发私信

感谢大家!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,056评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,842评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,938评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,296评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,292评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,413评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,824评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,493评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,686评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,281评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,820评论 3 305
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2 341

推荐阅读更多精彩内容