This is a sample SDK generated for the Speakeasy Bar API. Have a look around and familiarize yourself with the Speakeasy Product!
When you're ready you can use this modify this repo to reference your own OpenAPI spec or go back to the Speakeasy app to complete onboarding and generate your first SDK!
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- 🛠 Make your SDK feel handcrafted by customizing it
- ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
- 🎁 Publish your SDK to package managers by configuring automatic publishing
- ✨ When ready to productionize, delete this section from the README
Once you have the SDK setup you may want to iterate on the SDK. Speakeasy supports OpenAPI vendor extensions that can be added to your spec to customize the SDK ergonomics (method names, namespacing resources etc.) and functionality (adding retries, pagination, multiple server support etc)
To get started install the Speakeasy CLI.
In your terminal, run:
brew install speakeasy-api/homebrew-tap/speakeasyOnce you annonate your spec with an extension you will want to run speakeasy validate to check the spec for correctness and speakeasy generate to recreate the SDK locally. More documentation on OpenAPI extensions here. Here's an example of adding a multiple server support to the spec so that your SDK supports production and sandbox versions of your API. The attached Makefile also attaches some helper commands.
info:
title: Example
version: 0.0.1
servers:
- url: https://prod.example.com # Used as the default URL by the SDK
description: Our production environment
x-speakeasy-server-id: prod
- url: https://sandbox.example.com
description: Our sandbox environment
x-speakeasy-server-id: sandboxOnce you're finished iterating and happy with the output push only the latest version of spec into the repo and regenerate the SDK using step 6 above.
go get github.com/speakeasy-sdks/template-speakeasy-barpackage main
import (
"context"
templatespeakeasybar "github.com/speakeasy-sdks/template-speakeasy-bar"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/shared"
"log"
)
func main() {
s := templatespeakeasybar.New(
templatespeakeasybar.WithSecurity(""),
)
var drinkType *shared.DrinkType = shared.DrinkTypeSpirit
ctx := context.Background()
res, err := s.Drinks.ListDrinks(ctx, drinkType)
if err != nil {
log.Fatal(err)
}
if res.Drinks != nil {
// handle response
}
}- Authenticate - Authenticate with the API by providing a username and password.
- SubscribeToWebhooks - Subscribe to webhooks.
- GetDrink - Get a drink.
- ListDrinks - Get a list of drinks.
- ListIngredients - Get a list of ingredients.
- CreateOrder - Create an order.
Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!
Handling errors in your 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.
package main
import (
"context"
templatespeakeasybar "github.com/speakeasy-sdks/template-speakeasy-bar"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/operations"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/shared"
"log"
)
func main() {
s := templatespeakeasybar.New(
templatespeakeasybar.WithSecurity(""),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
var e *APIError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}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) |
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 ServerEnvironment -
WithOrganization string
For example:
package main
import (
"context"
templatespeakeasybar "github.com/speakeasy-sdks/template-speakeasy-bar"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/operations"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/shared"
"log"
)
func main() {
s := templatespeakeasybar.New(
templatespeakeasybar.WithSecurity(""),
templatespeakeasybar.WithServer("customer"),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
log.Fatal(err)
}
if res.Authenticate200ApplicationJSONObject != nil {
// handle response
}
}The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:
package main
import (
"context"
templatespeakeasybar "github.com/speakeasy-sdks/template-speakeasy-bar"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/operations"
"github.com/speakeasy-sdks/template-speakeasy-bar/pkg/models/shared"
"log"
)
func main() {
s := templatespeakeasybar.New(
templatespeakeasybar.WithSecurity(""),
templatespeakeasybar.WithServerURL("https://speakeasy.bar"),
)
ctx := context.Background()
res, err := s.Authentication.Authenticate(ctx, operations.AuthenticateRequestBody{})
if err != nil {
log.Fatal(err)
}
if res.Authenticate200ApplicationJSONObject != nil {
// handle response
}
}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:
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.
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.
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.
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!