GitHubAPI
Swift implementation of GitHub REST api v3. Library support Swift 4.2. Work is in progress.
Currently supported:
TODO:
- Activity API (Events, Starring, Watching).
- Organizations API.
- Projects API.
- Pull Requests API.
- Reactions API.
- Repositories API.
- Users API (Emails, Followers, Public Keys, GPG Keys, Block Another User).
- Documentation.
Example Usage
Authentication
Basic Authentication
This lib support Basic Authentication with login/password:
let authentication = BasicAuthentication(username: "username", password: "password")
UserAPI(authentication: authentication).getUser { (response, error) in
if let response = response {
print(response)
} else {
print(error ?? "")
}
}
OAuth2 Token (sent in a header)
If you generate personal access token or receive access token from OAuth2, you can use it with AccessTokenAuthentication:
let authentication = AccessTokenAuthentication(access_token: "token")
UserAPI(authentication: authentication).getUser(username: "serhii-londar") { (response, error) in
if let response = response {
print(response)
} else {
print(error ?? "")
}
}
OAuth2 Token (sent as a parameter)
If you generate personal access token or receive access token from OAuth2, you can use it in next way:
let authentication = TokenAuthentication(token: "token")
UserAPI(authentication: authentication).getAllUsers(since: "1") { (reposne, error) in
if let response = response {
print(response)
} else {
print(error ?? "")
}
}
Issues API
Create Issue:
let issue = Issue(title: "New Issue")
IssuesAPI(authentication: AccessTokenAuthentication(access_token: "access_token")).createIssue(owner: "owner", repository: "repository", issue: issue) { (response, error) in
if let response = response {
} else {
print(error ?? "")
}
}
Update Issue:
let issue = Issue(title: "Updated Issue")
IssuesAPI(authentication: AccessTokenAuthentication(access_token: "access_token")).updateIssue(owner: "owner", repository: "repository", number: number, issue: issue) { (response, error) in
if let response = response {
} else {
print(error ?? "")
}
}
Repositories API
Get list of all repositories of user:
RepositoriesAPI(authentication: AccessTokenAuthentication(access_token: "access_token")).repositories(user: "user", type: .all) { (response, error) in
if let response = response {
} else {
print(error ?? "")
}
}
Search API
Seart all repositories which contains qwer in name:
SearchAPI().searchRepositories(q: "qwer", page: 1, per_page: 100) { (response, error) in
if let response = response {
} else {
print(error ?? "")
}
}
Example Application
To run the example project, clone the repo, and run pod install from the Example directory first.
Example project contains example app with list of all user's GitHub notification.
Requirements
- Xcode 9 or later
- iOS 9.0 or later
- macOS 10.12 or later
- Ubuntu 16.04 or later
- Swift 4.0 or later
Installation
GitHubAPI is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'GithubAPI'
Author
Serhii Londar, [email protected]
License
GitHubAPI is available under the MIT license. See the LICENSE file for more info.
2.4k Dec 26, 2022
94 Dec 14, 2022
349 Dec 20, 2022
279 Jan 4, 2023
138 Dec 15, 2022
17 Jun 23, 2022
77 Jan 7, 2023
1 Jan 2, 2022
14 Dec 7, 2022
1.1k Dec 14, 2022
3 Aug 25, 2022
257 May 17, 2022
1 Jun 6, 2022
3 Sep 30, 2022
2.2k Nov 20, 2022
29 Dec 27, 2022
408 Nov 22, 2022
2 Nov 22, 2021
1k Nov 30, 2022
268 Aug 18, 2022
236 Dec 28, 2022
580 Nov 25, 2022
218 Jan 5, 2023
161 Dec 26, 2022
104 Jan 6, 2023
96 Dec 30, 2022
9 Jul 22, 2022
15 Aug 4, 2022
95 Sep 9, 2022