MoyaSugar
Syntactic sugar for Moya.
Why?
Moya is an elegant network abstraction layer which abstracts API endpoints gracefully with enum. However, it would become massive when the application is getting larger. Whenever you add an endpoint, you should write code at least 5 places: enum case, method, path, parameters and parameterEncoding property. It makes you scroll down again and again. Besides, if you would like to set different HTTP header fields, you should customize endpointClosure of MoyaProvider.
If you're as lazy as I am, MoyaSugar is for you.
At a Glance
Forget about method, path, parameters, parameterEncoding and endpointClosure. Use route, params, httpHeaderFields instead.
extension MyService: SugarTargetType {
var route: Route {
return .get("/me")
}
var params: Parameters? {
return JSONEncoding() => [
"username": "devxoul",
"password": "****",
]
}
var headers: [String: String]? {
return ["Accept": "application/json"]
}
}
Use MoyaSugarProvider instead of MoyaProvider.
let provider = MoyaSugarProvider<MyService>()
let provider = RxMoyaSugarProvider<MyService>() // If you're using Moya/RxSwift
Complete Example
import Moya
import Moyasugar
enum GitHubAPI {
case url(String)
case userRepos(owner: String)
case createIssue(owner: String, repo: String, title: String, body: String?)
case editIssue(owner: String, repo: String, number: Int, title: String?, body: String?)
}
extension GitHubAPI : SugarTargetType {
/// method + path
var route: Route {
switch self {
case .url(let urlString):
return .get(urlString)
case .userRepos(let owner):
return .get("/users/\(owner)/repos")
case .createIssue(let owner, let repo, _, _):
return .post("/repos/\(owner)/\(repo)/issues")
case .editIssue(let owner, let repo, let number, _, _):
return .patch("/repos/\(owner)/\(repo)/issues/\(number)")
}
}
// override default url building behavior
var url: URL {
switch self {
case .url(let urlString):
return URL(string: urlString)!
default:
return self.defaultURL
}
}
/// encoding + parameters
var params: Parameters? {
switch self {
case .url:
return nil
case .userRepos:
return nil
case .createIssue(_, _, let title, let body):
return JSONEncoding() => [
"title": title,
"body": body,
]
case .editIssue(_, _, _, let title, let body):
// Use `URLEncoding()` as default when not specified
return [
"title": title,
"body": body,
]
}
}
var headers: [String: String]? {
return [
"Accept": "application/json"
]
}
}
APIs
-
🔗 protocol SugarTargetType- extension GitHubAPI: TargetType + extension GitHubAPI: SugarTargetType
-
🔗 var route: RouteReturns
Routewhich contains HTTP method and URL path information.- var method: Method { get } - var path: String { get } + var route: Route { get }
Example:
var route: Route { return .get("/me") }
-
🔗 var url: URLReturns the request URL. It retuens
defaultURLas default, which is the combination ofbaseURLandpath. Implement this property to return custom url. See #6 for detail. -
🔗 var params: Parameters?Returns
Parameterswhich contains parameter encoding and values.- var parameters: [String: Any]? { get } + var params: Parameters? { get }
Example:
var params: Parameters? { return JSONEncoding() => [ "username": "devxoul", "password": "****", ] }
Note: If the
MoyaSugarProvideris initialized with anendpointClosureparameter, HTTP header fields ofendpointClosurewill be used. This is how to extend the target's HTTP header fields inendpointClosure:let endpointClosure: (GitHubAPI) -> Endpoint<GitHubAPI> = { target in let defaultEndpoint = MoyaProvider.defaultEndpointMapping(for: target) return defaultEndpoint .adding(newHTTPHeaderFields: ["Authorization": "MySecretToken"]) }
Requirements
Same with Moya
Installation
-
Using CocoaPods:
pod 'MoyaSugar' pod 'MoyaSugar/RxSwift' # Use with RxSwift
MoyaSugar currently doesn't cupport Carthage.
Contributing
$ TEST=1 swift package generate-xcodeproj
$ open MoyaSugar.xcodeproj
License
MoyaSugar is under MIT license. See the LICENSE file for more info.
4 Jun 10, 2022
154 Jun 29, 2022
171 Nov 4, 2022
1.1k Dec 29, 2022
1 Jul 6, 2021
8 Jan 25, 2022
3.8k Jan 5, 2023
4.6k Dec 27, 2022
4k Jan 4, 2023
31 Jul 1, 2019
76 Dec 17, 2022
100 Jan 6, 2023
2 Jan 31, 2022
2 Feb 6, 2022
964 Dec 14, 2022