3.8 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| EdgeConnect SDK | SDK | 10 | Software Development Kit for interacting with EdgeConnect |
Overview
The EdgeConnect SDK is a Go library which provides a simple method for interacting with Edge Connect within programs. It is designed to be used by other tools, such as the EdgeConnect Client or Terraform provider,
Key Features
- Allows querying endpoints without the need to manage API calls and responses directly
- Wraps the existing Edge Connect API
- Supports multiple unnumbered versions of the API
Purpose in EDP
No system can be considered useful unless it is actually, in practice, used. While the Edge Connect console and API are essential tools to allow the platform to be used by developers, there are numerous use cases for interaction that is automated but simpler to use than an API. These include a command-line tool and Terraform provider.
While each such tool could simply independently wrap existing endpoints, this is generally too low-level for sustainable development. It would involve extensive boilerplate code in each such package, plus small changes to API endpoints or error handling may require constant rework.
To avoid this, the Edge Connect SDK aims to provide a common library for interacting with EdgeConnect, allowing the abstraction of HTTP requests and authentication procedures while nonetheless allowing access directly to the endpoints available.
Repository
Code: https://edp.buildth.ing/DevFW-CICD/edge-connect-client
Documentation: https://edp.buildth.ing/DevFW-CICD/edge-connect-client/src/branch/main/sdk
Getting Started
Prerequisites
- Golang
- Edge Connect credentials
Quick Start
[Step-by-step guide to get started with this component]
- Simply import the SDK to your project
- Initialise and configure a client with your credentials
- Build your code around the existing endpoints
Verification
[How to verify the component is working correctly]
Usage Examples
See README for simple code examples, or repositories for EdgeConnect Client and Terraform provider for full projects relying on it.
Troubleshooting
Varying code versions
Problem: While the Edge Connect API does not (at time of writing) have different semantic versions, it does have different iterations which function differently. The SDK provides two different libraries, labelled v1 and v2 and referring to API definitions similarly stored as v1 and v2.
Solution: If you receive errors when using the SDK, consider changing the version you import:
import v1 "edp.buildth.ing/DevFW-CICD/edge-connect-client/sdk/edgeconnect"
import v2 "edp.buildth.ing/DevFW-CICD/edge-connect-client/v2/sdk/edgeconnect/v2"
Status
Maturity: Beta