{"id":3034,"url":"https://github.com/devxoul/MoyaSugar","last_synced_at":"2025-08-03T12:32:00.191Z","repository":{"id":41390172,"uuid":"71129592","full_name":"devxoul/MoyaSugar","owner":"devxoul","description":"🍯 Syntactic sugar for Moya","archived":false,"fork":false,"pushed_at":"2022-07-21T23:59:24.000Z","size":127,"stargazers_count":191,"open_issues_count":5,"forks_count":30,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-08T22:45:12.557Z","etag":null,"topics":["alamofire","moya","rxswift","syntactic-sugar"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devxoul.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-17T11:09:05.000Z","updated_at":"2024-04-19T02:43:15.000Z","dependencies_parsed_at":"2022-08-10T02:07:11.967Z","dependency_job_id":null,"html_url":"https://github.com/devxoul/MoyaSugar","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devxoul%2FMoyaSugar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devxoul%2FMoyaSugar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devxoul%2FMoyaSugar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devxoul%2FMoyaSugar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devxoul","download_url":"https://codeload.github.com/devxoul/MoyaSugar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228543279,"owners_count":17934455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alamofire","moya","rxswift","syntactic-sugar"],"created_at":"2024-01-05T20:16:29.526Z","updated_at":"2024-12-07T00:31:14.703Z","avatar_url":"https://github.com/devxoul.png","language":"Swift","funding_links":[],"categories":["Utility"],"sub_categories":["Web View","Other free courses"],"readme":"# MoyaSugar\n\n![Swift](https://img.shields.io/badge/Swift-5.1-orange.svg)\n[![CI](https://github.com/devxoul/MoyaSugar/workflows/CI/badge.svg)](https://github.com/devxoul/MoyaSugar/workflows/actions)\n[![CocoaPods](http://img.shields.io/cocoapods/v/MoyaSugar.svg)](https://cocoapods.org/pods/MoyaSugar)\n\nSyntactic sugar for Moya.\n\n## Why?\n\n[Moya](https://github.com/Moya/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`.\n\nIf you're as lazy as I am, MoyaSugar is for you.\n\n## At a Glance\n\nForget about `method`, `path`, `parameters`, `parameterEncoding` and `endpointClosure`. Use `route`, `params`, `httpHeaderFields` instead.\n\n```swift\nextension MyService: SugarTargetType {\n  var route: Route {\n    return .get(\"/me\")\n  }\n\n  var params: Parameters? {\n    return JSONEncoding() =\u003e [\n      \"username\": \"devxoul\",\n      \"password\": \"****\",\n    ]\n  }\n\n  var headers: [String: String]? {\n    return [\"Accept\": \"application/json\"]\n  }\n}\n```\n\nUse `MoyaSugarProvider` instead of `MoyaProvider`.\n\n```swift\nlet provider = MoyaSugarProvider\u003cMyService\u003e()\nlet provider = RxMoyaSugarProvider\u003cMyService\u003e() // If you're using Moya/RxSwift\n```\n\n## Complete Example\n\n```swift\nimport Moya\nimport Moyasugar\n\nenum GitHubAPI {\n  case url(String)\n  case userRepos(owner: String)\n  case createIssue(owner: String, repo: String, title: String, body: String?)\n  case editIssue(owner: String, repo: String, number: Int, title: String?, body: String?)\n}\n\nextension GitHubAPI : SugarTargetType {\n\n  /// method + path\n  var route: Route {\n    switch self {\n    case .url(let urlString):\n      return .get(urlString)\n\n    case .userRepos(let owner):\n      return .get(\"/users/\\(owner)/repos\")\n\n    case .createIssue(let owner, let repo, _, _):\n      return .post(\"/repos/\\(owner)/\\(repo)/issues\")\n\n    case .editIssue(let owner, let repo, let number, _, _):\n      return .patch(\"/repos/\\(owner)/\\(repo)/issues/\\(number)\")\n    }\n  }\n\n  // override default url building behavior\n  var url: URL {\n    switch self {\n    case .url(let urlString):\n      return URL(string: urlString)!\n    default:\n      return self.defaultURL\n    }\n  }\n\n  /// encoding + parameters\n  var params: Parameters? {\n    switch self {\n    case .url:\n      return nil\n\n    case .userRepos:\n      return nil\n\n    case .createIssue(_, _, let title, let body):\n      return JSONEncoding() =\u003e [\n        \"title\": title,\n        \"body\": body,\n      ]\n\n    case .editIssue(_, _, _, let title, let body):\n      // Use `URLEncoding()` as default when not specified\n      return [\n        \"title\": title,\n        \"body\": body,\n      ]\n    }\n  }\n\n  var headers: [String: String]? {\n    return [\n      \"Accept\": \"application/json\"\n    ]\n  }\n\n}\n```\n\n## APIs\n\n- \u003ca name=\"api-sugartargettype\" href=\"#api-sugartargettype\"\u003e🔗\u003c/a\u003e **`protocol SugarTargetType`**\n\n    ```diff\n    - extension GitHubAPI: TargetType\n    + extension GitHubAPI: SugarTargetType\n    ```\n\n- \u003ca name=\"api-route\" href=\"#api-route\"\u003e🔗\u003c/a\u003e **`var route: Route`**\n\n    Returns `Route` which contains HTTP method and URL path information.\n\n    ```diff\n    - var method: Method { get }\n    - var path: String { get }\n    + var route: Route { get }\n    ```\n\n    Example:\n\n    ```swift\n    var route: Route {\n      return .get(\"/me\")\n    }\n    ```\n\n- \u003ca name=\"api-url\" href=\"#api-url\"\u003e🔗\u003c/a\u003e **`var url: URL`**\n\n    Returns the request URL. It retuens `defaultURL` as default, which is the combination of `baseURL` and `path`. Implement this property to return custom url. See [#6](https://github.com/devxoul/MoyaSugar/pull/6) for detail.\n\n\n- \u003ca name=\"api-params\" href=\"#api-params\"\u003e🔗\u003c/a\u003e **`var params: Parameters?`**\n\n    Returns `Parameters` which contains parameter encoding and values.\n\n    ```diff\n    - var parameters: [String: Any]? { get }\n    + var params: Parameters? { get }\n    ```\n\n    Example:\n\n    ```swift\n    var params: Parameters? {\n      return JSONEncoding() =\u003e [\n        \"username\": \"devxoul\",\n        \"password\": \"****\",\n      ]\n    }\n    ```\n\n    Note: If the `MoyaSugarProvider` is initialized with an `endpointClosure` parameter, HTTP header fields of `endpointClosure` will be used. This is how to extend the target's HTTP header fields in `endpointClosure`:\n\n    ```swift\n    let endpointClosure: (GitHubAPI) -\u003e Endpoint\u003cGitHubAPI\u003e = { target in\n      let defaultEndpoint = MoyaProvider.defaultEndpointMapping(for: target)\n      return defaultEndpoint\n        .adding(newHTTPHeaderFields: [\"Authorization\": \"MySecretToken\"])\n    }\n    ```\n\n## Requirements\n\nSame with [Moya](https://github.com/Moya/Moya)\n\n## Installation\n\n- **Using [CocoaPods](https://cocoapods.org)**:\n\n    ```ruby\n    pod 'MoyaSugar'\n    pod 'MoyaSugar/RxSwift' # Use with RxSwift\n    ```\n\n\u003e MoyaSugar currently doesn't cupport Carthage.\n\n## Contributing\n\n```console\n$ TEST=1 swift package generate-xcodeproj\n$ open MoyaSugar.xcodeproj\n```\n\n## License\n\n**MoyaSugar** is under MIT license. See the [LICENSE](LICENSE) file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevxoul%2FMoyaSugar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevxoul%2FMoyaSugar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevxoul%2FMoyaSugar/lists"}