{"id":18051703,"url":"https://github.com/apimatic/go-core-runtime","last_synced_at":"2025-04-10T18:15:07.156Z","repository":{"id":60748846,"uuid":"544976565","full_name":"apimatic/go-core-runtime","owner":"apimatic","description":"This project contains core logic and the utilities for the APIMatic's Go SDK","archived":false,"fork":false,"pushed_at":"2025-02-10T07:32:45.000Z","size":281,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T15:52:31.714Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/apimatic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2022-10-03T15:09:38.000Z","updated_at":"2025-02-10T07:32:31.000Z","dependencies_parsed_at":"2024-01-22T14:13:39.214Z","dependency_job_id":"7cec7d88-88a2-4e73-af9e-fb5fa1090660","html_url":"https://github.com/apimatic/go-core-runtime","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fgo-core-runtime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fgo-core-runtime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fgo-core-runtime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fgo-core-runtime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apimatic","download_url":"https://codeload.github.com/apimatic/go-core-runtime/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248269600,"owners_count":21075783,"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":[],"created_at":"2024-10-30T22:55:02.237Z","updated_at":"2025-04-10T18:15:07.138Z","avatar_url":"https://github.com/apimatic.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started with Go Core Runtime\n[![Go Reference](https://pkg.go.dev/badge/github.com/apimatic/go-core-runtime.svg)](https://pkg.go.dev/github.com/apimatic/go-core-runtime)\n[![GitHub release](https://img.shields.io/github/v/release/apimatic/go-core-runtime)](https://pkg.go.dev/github.com/apimatic/go-core-runtime?tab=versions)\n[![Licence][license-badge]][license-url]\n[![Tests][test-badge]][test-url]\n[![Test Coverage](https://api.codeclimate.com/v1/badges/2c5a5f8dca8e970ac36e/test_coverage)](https://codeclimate.com/github/apimatic/go-core-runtime/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/2c5a5f8dca8e970ac36e/maintainability)](https://codeclimate.com/github/apimatic/go-core-runtime/maintainability)\n\n## Introduction\n\nThe `go-core-runtime` is a core library for Apimatic's Go SDK, providing essential utilities and structures for handling API requests and responses using the HTTP protocol. For detailed API documentation and usage examples, visit the [GoDoc documentation](https://pkg.go.dev/github.com/apimatic/go-core-runtime).\n\n## Requirement\n\nThis package requires Go v1.18 or higher.\n\n## Installation\n\nTo install the package, you can use `go get`:\n\n```bash\ngo get github.com/apimatic/go-core-runtime\n```\n\nAlternatively, you can add the package manually to your go.mod file:\n\n\n```go\nrequire \"github.com/apimatic/go-core-runtime\" v0.0.x\n```\nThen, run the following command to install the package automatically:\n\n```go\ngo get ./...\n```\n\n## Package Details \nFollowing is a list of all packages. Here each package contains its own test files.\n\n### HTTPS\nThe https package provides logic related to HTTP requests, including building and making the request call. It offers features such as handling form data, file parameters, headers, and interceptors.\n\n| File Name                                            | Description                                                                                     |\n|------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [`API Response`](https/apiResponse.go)               | Provides a struct around the HTTP response and the data.                                        |\n| [`API Error`](https/apiError.go)                     | Provides a structure to represent error responses from API calls.                               |\n| [`Array Serialization`](https/arraySerialization.go) | Provides constants for array serialization like Indexed, Plain, etc.                            |\n| [`Auth Group`](https/authenticationGroup.go)         | Provides capability to group authentication keys into groups.                                   |\n| [`Auth Interface`](https/authenticationInterface.go) | Defines the functionality of an authentication manager.                                         |\n| [`Call Builder`](https/callBuilder.go)               | Provides the logic related to the HTTPs request. Includes building and making the request call. |\n| [`File Wrapper`](https/fileWrapper.go)               | Provides a wrapper for file parameters to use in the HTTPs calls.                               |\n| [`Form Data`](https/formData.go)                     | Provides handling of form parameters in the request.                                            |\n| [`HTTP Client`](https/httpClient.go)                 | Provides an interface for the HTTP Client to use for making the calls.                          |\n| [`HTTP Configuration`](https/httpConfiguration.go)   | Provides configurations for the HTTP calls.                                                     |\n| [`HTTP Context`](https/httpContext.go)               | Provides a struct that holds request and corresponding response instances.                      |\n| [`HTTP Headers`](https/httpHeaders.go)               | Provides handling for headers to send with the request.                                         |\n| [`Internal Error`](https/internalError.go)           | Provides handling for internal errors that may occur during the API calls.                      |\n| [`Interceptors`](https/interceptors.go)              | Provides handling to intercept requests.                                                        |\n| [`Retryer`](https/retryer.go)                        | Provides handling to automatically retry for failed requests.                                   |\n\n### Logger\nThe logger package provides logic related to logging. It offers the Facade Design Pattern for configuring the Logger and SDK Logger. Additionally, it provides the LoggerConfiguration to customize logging behavior.\n\n| File Name                                                                | Description                                                                                                                   |\n|--------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| [`Console Logger`](logger/defaultLogger.go)                              | Provides default implementation of [`Logger Interface`](logger/defaultLogger.go) to log messages.                             |\n| [`Level`](logger/level.go)                                               | Provides constants for log level like Level_ERROR, Level_INFO, etc.                                                           |\n| [`Logger Configuration`](logger/loggerConfiguration.go)                  | Provides logging configurations for the Sdk Logger.                                                                           |\n| [`Response Logger Configuration`](logger/responseLoggerConfiguration.go) | Provides response logging configurations for the Sdk Logger.                                                                  |\n| [`Request Logger Configuration`](logger/requestLoggerConfiguration.go)   | Provides request logging configurations for the Sdk Logger.                                                                   |\n| [`Sdk Logger`](logger/sdkLogger.go)                                      | Provides default and null implementation of [` Sdk Logger Interface`](logger/sdkLogger.go) to log API requests and responses. |\n\n### Test Helper\nPackage testHelper provides helper functions for testing purposes.\n\n| File Name                                                | Description                                                               |\n|----------------------------------------------------------|---------------------------------------------------------------------------|\n| [`BodyMatchers`](testHelper/bodyMatchers.go)             | Provides functions to match JSON response bodies with expected bodies.    |\n| [`HeadersMatchers`](testHelper/headersMatchers.go)       | Provides functions to match HTTP headers with expected headers.           |\n| [`StatusCodeMatchers`](testHelper/statusCodeMatchers.go) | Provides functions to match HTTP status codes with expected status codes. |\n\n### Types\nPackage types provides utility types and functions.\n\n| File Name                       | Description                                                  |\n|---------------------------------|--------------------------------------------------------------|\n| [`Optional`](types/optional.go) | Provides a wrapper to use any type as optional and nullable. |\n\n### Utilities\nThe utilities package provides utility functions for making HTTP calls.\n\n| File Name                                               | Description                                                                                     |\n|---------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [`API Helper`](utilities/apiHelper.go)                  | Provides helper functions for making the HTTP calls.                                            |\n| [`Marshal Error`](utilities/marshal_error.go)           | Defines a structure for error that will be returned if marshalling/unmarshalling fail.          |\n| [`Union Type Helper`](utilities/unionTypeHelper.go)     | Provides helper functions for unmarshalling containers of multiple types.                       |\n| [`Additional Properties`](utilities/additionalProperties.go) | Provides helper functions for handling additional properties. |\n\n## Contributing\nContributions are welcome! If you encounter any issues or have suggestions for improvement, please open an issue.\n\n## License\nThis project is licensed under the [MIT License](LICENSE).\n\n\n## Contact\nFor any questions or support, please feel free to contact us at support@apimatic.io.\n\n\n[license-badge]: https://img.shields.io/badge/licence-MIT-blue\n[license-url]: LICENSE\n[test-badge]: https://github.com/apimatic/go-core-runtime/actions/workflows/test.yaml/badge.svg\n[test-url]: https://github.com/apimatic/go-core-runtime/actions/workflows/test.yaml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fgo-core-runtime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapimatic%2Fgo-core-runtime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fgo-core-runtime/lists"}