Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/test-bar
A go SDK for accessing the test-bar API.
https://github.com/speakeasy-sdks/test-bar
Last synced: 1 day ago
JSON representation
A go SDK for accessing the test-bar API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/test-bar
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-09-27T07:58:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:46:04.000Z (7 months ago)
- Last Synced: 2024-06-21T21:05:31.576Z (5 months ago)
- Language: Go
- Size: 165 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# github.com/speakeasy-sdks/test-bar
## SDK Installation
```bash
go get github.com/speakeasy-sdks/test-bar
```
## SDK Example Usage
### Example
```go
package main
import (
"context"
testbar "github.com/speakeasy-sdks/test-bar"
"github.com/speakeasy-sdks/test-bar/pkg/models/operations"
"github.com/speakeasy-sdks/test-bar/pkg/models/shared"
"log"
)
func main() {
s := testbar.New(
testbar.WithSecurity(""),
)
ctx := context.Background()
res, err := s.Drinks.GetDrink(ctx, operations.GetDrinkRequest{
Name: "",
})
if err != nil {
log.Fatal(err)
}
if res.Drink != nil {
// handle response
}
}
```
## Available Resources and Operations
### [Authentication](docs/sdks/authentication/README.md)
* [Authenticate](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.
### [Drinks](docs/sdks/drinks/README.md)
* [GetDrink](docs/sdks/drinks/README.md#getdrink) - Get a drink.
* [ListDrinks](docs/sdks/drinks/README.md#listdrinks) - Get a list of drinks.
### [Ingredients](docs/sdks/ingredients/README.md)
* [ListIngredients](docs/sdks/ingredients/README.md#listingredients) - Get a list of ingredients.
### [Orders](docs/sdks/orders/README.md)
* [CreateOrder](docs/sdks/orders/README.md#createorder) - Create an order.
### [Config](docs/sdks/config/README.md)
* [SubscribeToWebhooks](docs/sdks/config/README.md#subscribetowebhooks) - Subscribe to webhooks.
## Special Types
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
| Error Object | Status Code | Content Type |
| ------------------ | ------------------ | ------------------ |
| sdkerrors.APIError | 5XX | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
### Example
```go
package main
import (
"context"
"errors"
testbar "github.com/speakeasy-sdks/test-bar"
"github.com/speakeasy-sdks/test-bar/pkg/models/operations"
"github.com/speakeasy-sdks/test-bar/pkg/models/sdkerrors"
"log"
)
func main() {
s := testbar.New()
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
var e *sdkerrors.APIError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}
```
## Server Selection
### Select Server by Name
You can override the default server globally using the `WithServer` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Variables |
| ----- | ------ | --------- |
| `prod` | `https://speakeasy.bar` | None |
| `staging` | `https://staging.speakeasy.bar` | None |
| `customer` | `https://{organization}.{environment}.speakeasy.bar` | `environment` (default is `prod`), `organization` (default is `api`) |
#### Example
```go
package main
import (
"context"
testbar "github.com/speakeasy-sdks/test-bar"
"github.com/speakeasy-sdks/test-bar/pkg/models/operations"
"log"
)
func main() {
s := testbar.New(
testbar.WithServer("customer"),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
* `WithEnvironment testbar.ServerEnvironment`
* `WithOrganization string`
### Override Server URL Per-Client
The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
```go
package main
import (
"context"
testbar "github.com/speakeasy-sdks/test-bar"
"github.com/speakeasy-sdks/test-bar/pkg/models/operations"
"log"
)
func main() {
s := testbar.New(
testbar.WithServerURL("https://speakeasy.bar"),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
```
## Custom HTTP Client
The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
```go
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}
```
The built-in `net/http` client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
```go
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)
```
This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| -------- | -------- | -------- |
| `APIKey` | apiKey | API key |
You can configure it using the `WithSecurity` option when initializing the SDK client instance. For example:
```go
package main
import (
"context"
testbar "github.com/speakeasy-sdks/test-bar"
"github.com/speakeasy-sdks/test-bar/pkg/models/operations"
"log"
)
func main() {
s := testbar.New(
testbar.WithSecurity(""),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
```
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)