{"id":30106808,"url":"https://github.com/createapi/urlqueryencoder","last_synced_at":"2025-08-10T01:10:44.210Z","repository":{"id":63907255,"uuid":"442327217","full_name":"CreateAPI/URLQueryEncoder","owner":"CreateAPI","description":"URL query encoder with support for all OpenAPI serialization options","archived":false,"fork":false,"pushed_at":"2023-02-10T18:56:16.000Z","size":20,"stargazers_count":42,"open_issues_count":3,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-13T23:02:31.071Z","etag":null,"topics":[],"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/CreateAPI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-28T02:29:04.000Z","updated_at":"2025-04-22T03:55:21.000Z","dependencies_parsed_at":"2024-05-13T15:08:45.449Z","dependency_job_id":"f6e7ad08-34b2-4f31-90da-248df86e4020","html_url":"https://github.com/CreateAPI/URLQueryEncoder","commit_stats":null,"previous_names":["kean/urlqueryencoder"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/CreateAPI/URLQueryEncoder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateAPI%2FURLQueryEncoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateAPI%2FURLQueryEncoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateAPI%2FURLQueryEncoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateAPI%2FURLQueryEncoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CreateAPI","download_url":"https://codeload.github.com/CreateAPI/URLQueryEncoder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CreateAPI%2FURLQueryEncoder/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269660638,"owners_count":24455326,"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","status":"online","status_checked_at":"2025-08-09T02:00:10.424Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-08-10T01:10:39.938Z","updated_at":"2025-08-10T01:10:44.146Z","avatar_url":"https://github.com/CreateAPI.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# URLQueryEncoder\n\nA customizable Swift `Encoder` that encodes instances of data types as URL query items. Supports all OpenAPI [serialization options](https://swagger.io/docs/specification/serialization/).\n\n## Examples\n\n### Encoding Primitives\n\n```swift\nlet encoder = URLQueryEncoder()\nencoder.encode(id, forKey: \"id\")\n\nprint(encoder.queryItems)\n// [URLQueryItem(name: \"id\", value: \"5\")]\n```\n\nBy default, optional values are not encoded.\n\n```swift\nvar id: Int?\nlet encoder = URLQueryEncoder()\nencoder.encode(id, forKey: \"id\")\n\nprint(encoder.queryItems)\n// []\n```\n\n### Encoding Arrays\n\n```swift\nlet ids = [3, 4, 5]\nlet encoder = URLQueryEncoder()\nencoder.encode(ids, forKey: \"id\")\n\n// Query: \"id=3\u0026id=4\u0026id=5\"\n```\n\nWith an `explode` option disabled:\n\n```swift\nlet ids = [3, 4, 5]\nlet encoder = URLQueryEncoder()\nencoder.encode(ids, forKey: \"id\", explode: false)\n\n// Query: \"id=3,4,5\"\n```\n\nWith an `explode` option disabled and a custom delimiter:\n\n```swift\nlet ids = [3, 4, 5]\nlet encoder = URLQueryEncoder()\nencoder.encode(ids, forKey: \"id\", explode: false, delimeter: \"|\")\n\n// Query: \"id=3|4|5\"\n```\n\n### Encoding Objects\n\n```swift\nlet user = User(role: \"admin\", name: \"kean\")\n\nlet encoder = URLQueryEncoder()\nencoder.encode(user, forKey: \"id\")\n\n// Query: \"role=admin\u0026name=kean\"\n```\n\nWith an `explode` option disabled:\n\n```swift\nlet user = User(role: \"admin\", name: \"kean\")\n\nlet encoder = URLQueryEncoder()\nencoder.encode(user, forKey: \"id\", explode: false)\n\n// Query: \"id=role,admin,name,kean\"\n```\n\nAs a \"deep\" object:\n\n```swift\nlet user = User(role: \"admin\", name: \"kean\")\n\nlet encoder = URLQueryEncoder()\nencoder.encode(user, forKey: \"id\", isDeepObject: true)\n\n// Query: \"id[role]=admin\u0026id[name]=kean\")\"\n```\n\n\u003e If you are encoding a request body using URL-form encoding, you can use a convenience `URLQueryEncoder.encode(_:)` method. \n\n## Encoding Options\n\nThere are two ways to change the encoding options. You can set them directly on `URLQueryEncoder` instance.\n\n```swift\nlet encoder = URLQueryEncoder()\nencoder.explode = false\nencoder.isDeepObject = true\nencoder.delimiter = \"|\"\nencoder.dateEncodingStrategy = .millisecondsSince1970\n```\n\nOr pass options in each individual `encode` call. \n\n```swift\nlet user = User(role: \"admin\", name: \"kean\")\nlet ids = [3, 4, 5]\n\nlet encoder = URLQueryEncoder()\nencoder.encode(ids, forKey: \"ids\", explode: false)\nencoder.encode(ids, forKey: \"ids2\", explode: true)\nencoder.encode(user, forKey: \"user\", isDeepObject: true)\nencoder.encode(2, forKey: \"id\")\n\n// Query: \"ids=3,4,5\u0026ids2=3\u0026ids2=4\u0026ids2=5\u0026user[role]=admin\u0026user[name]=kean\u0026id=2\"\n```\n\nThe reason it's designed this way is that in OpenAPI each parameter can come with different serialization options.\n\n## Accessing Results\n\nYou can access the encoding results at any time, and they come in different forms:\n\n```swift\npublic final class URLQueryEncoder {\n    // Encoded query items.\n    public var queryItems: [URLQueryItem]\n    // Encoded query items as name-value pairs.\n    public var items: [(String, String?)]\n    // The encoded query items as a URL query subcomponent.\n    public var query: String?\n    // The encoded query items as a URL query subcomponent with percent-encoded values.\n    public var percentEncodedQuery: String?\n}\n```\n\n## License\n\nURLQueryEncoder is available under the MIT license. See the LICENSE file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreateapi%2Furlqueryencoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreateapi%2Furlqueryencoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreateapi%2Furlqueryencoder/lists"}