Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicholastd07/swiftdailyapi
A Swift API framework for ZhiHu's Daily News.
https://github.com/nicholastd07/swiftdailyapi
api carthage cocoapods daily rest-api swift zhihu
Last synced: 4 days ago
JSON representation
A Swift API framework for ZhiHu's Daily News.
- Host: GitHub
- URL: https://github.com/nicholastd07/swiftdailyapi
- Owner: NicholasTD07
- License: mit
- Created: 2015-05-28T01:46:38.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2018-06-02T11:56:15.000Z (over 6 years ago)
- Last Synced: 2024-12-08T22:14:01.777Z (15 days ago)
- Topics: api, carthage, cocoapods, daily, rest-api, swift, zhihu
- Language: Swift
- Size: 198 KB
- Stars: 197
- Watchers: 6
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftDailyAPI
[](https://travis-ci.org/NicholasTD07/SwiftDailyAPI)
[](https://codecov.io/github/NicholasTD07/SwiftDailyAPI?branch=develop)
[](https://img.shields.io/cocoapods/v/SwiftDailyAPI.svg)
[](https://github.com/Carthage/Carthage)
An API framework for ZhiHu's Daily News, built in Swift. It is powering my open
source App [Swift-ZHI](https://github.com/NicholasTD07/Swift-ZHI) which is a
newsreader App built for ZhiHu's Daily News.
## Requirement
* iOS 8.0+ / Mac OS X 10.9+
* Xcode 7.2 +
## Installation
> **Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).**
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
> CocoaPods 0.39.0+ is required to build SwiftDailyAPI 2.0.0+.
To integrate SwiftDailyAPI into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
platform :ios, '8.0'
use_frameworks!
pod 'SwiftDailyAPI', '~> 2.0'
```
Then, run the following command:
```bash
$ pod install
```
### [Carthage]
[Carthage]: https://github.com/Carthage/Carthage
Add the following to your Cartfile:
```
github "NicholasTD07/SwiftDailyAPI" ~> 2.0.0 # Swift 2.1
github "NicholasTD07/SwiftDailyAPI" ~> 1.0.0 # Swift 1.2
```
Then run `carthage update`.
Follow the current instructions in [Carthage's README][carthage-installation]
for up to date installation instructions.
[carthage-installation]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application
## Usage
```swift
import SwiftDailyAPI
// Setup
var latestDaily: LatestDaily?
var daily: Daily?
var news: News?
var newsExtra: NewsExtra?
var shortComments, longComments: Comments?
// Given
let newsId = 4772308
let date = NSDate.dateFromString("20150525", format: DailyConstants.dateFormat)!
let api = DailyAPI(userAgent: "SwiftDailyAPI_ReadMe")
// When
api.latestDaily { latestDailyFromAPI in
latestDaily = latestDailyFromAPI
print(latestDaily?.news)
print(latestDaily?.topNews)
}
api.daily(forDate: date) { dailyFromAPI in
daily = dailyFromAPI
print(daily?.news)
}
api.news(newsId) { newsFromAPI in
news = newsFromAPI
print(news?.newsId)
print(news?.title)
}
api.newsExtra(newsId) { newsExtraFromAPI in
newsExtra = newsExtraFromAPI
print(newsExtra?.popularity)
print(newsExtra?.comments)
}
api.comments(newsId, shortCommentsHandler: { comments in
shortComments = comments
print(shortComments?.comments)
}, longCommentsHandler: { comments in
longComments = comments
print(longComments?.comments)
})
// Then
// expect all vars in `Setup` section to not be nil
// code in `ReadmeCodeSpecs.swift`
```
This code is tested in [ReadmeCodeSpecs.swift](./SwiftDailyAPITests/Specs/ReadmeCodeSpecs.swift). There's also a `Then` part in the spec which expects all the vars in the `Setup` to not be nil.
## Frameworks
* [Alamofire] - Elegant HTTP networking
* [Argo] - Functional JSON parsing
* [Quick] - Testing
* [Nimble] - Matcher
## Appendix
### How does SwiftDailyAPI support both Carthage and CocoaPods while having 3rd parity dependencies?
Well, it works like this. Before 2.0.1, I was using Carthage to manage
dependencies so Carthage works for version 2.0.0. However, I switched to
CocoaPods since 2.0.1 because it's easier to setup, more stable from my
experience, also takes less time to install dependencies (Carthage has one extra
build step) and Travis has caching for CocoaPods.
[Alamofire]: https://github.com/Alamofire/Alamofire
[Argo]: https://github.com/thoughtbot/Argo
[Quick]: https://github.com/Quick/Quick
[Nimble]: https://github.com/Quick/Nimble