go get github.com/speakeasy-sdks/bolt-alpha-spec
package main
import (
"context"
boltalphaspec "github.com/speakeasy-sdks/bolt-alpha-spec"
"github.com/speakeasy-sdks/bolt-alpha-spec/pkg/models/shared"
"log"
"net/http"
)
func main() {
s := boltalphaspec.New()
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx, shared.Pet{
ID: 596804,
Name: "<value>",
})
if err != nil {
log.Fatal(err)
}
if res.StatusCode == http.StatusOK {
// handle response
}
}
- CreatePets - Create a pet
- ListPets - List all pets
- ShowPetByID - Info for a specific pet
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.SDKError | 4xx-5xx | / |
package main
import (
"context"
"errors"
boltalphaspec "github.com/speakeasy-sdks/bolt-alpha-spec"
"github.com/speakeasy-sdks/bolt-alpha-spec/pkg/models/sdkerrors"
"github.com/speakeasy-sdks/bolt-alpha-spec/pkg/models/shared"
"log"
)
func main() {
s := boltalphaspec.New()
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx, shared.Pet{
ID: 596804,
Name: "<value>",
})
if err != nil {
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}
You can override the default server globally using the WithServerIndex
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 indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | http://petstore.swagger.io/v1 |
None |
package main
import (
"context"
boltalphaspec "github.com/speakeasy-sdks/bolt-alpha-spec"
"github.com/speakeasy-sdks/bolt-alpha-spec/pkg/models/shared"
"log"
"net/http"
)
func main() {
s := boltalphaspec.New(
boltalphaspec.WithServerIndex(0),
)
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx, shared.Pet{
ID: 596804,
Name: "<value>",
})
if err != nil {
log.Fatal(err)
}
if res.StatusCode == http.StatusOK {
// 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"
boltalphaspec "github.com/speakeasy-sdks/bolt-alpha-spec"
"github.com/speakeasy-sdks/bolt-alpha-spec/pkg/models/shared"
"log"
"net/http"
)
func main() {
s := boltalphaspec.New(
boltalphaspec.WithServerURL("http://petstore.swagger.io/v1"),
)
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx, shared.Pet{
ID: 596804,
Name: "<value>",
})
if err != nil {
log.Fatal(err)
}
if res.StatusCode == http.StatusOK {
// 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!