go get github.com/speakeasy-sdks/jkjklsdlfkpackage main
import (
"context"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/shared"
)
func main() {
s := petstore.New(
petstore.WithSecurity("<YOUR_PETSTORE_AUTH_HERE>"),
)
request := shared.Pet{
Category: &shared.Category{
ID: petstore.Int64(1),
Name: petstore.String("Dogs"),
},
ID: petstore.Int64(10),
Name: "doggie",
PhotoUrls: []string{
"<value>",
},
}
ctx := context.Background()
res, err := s.Pet.AddPetForm(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.Pet != nil {
// handle response
}
}- AddPetForm - Add a new pet to the store
- AddPetJSON - Add a new pet to the store
- AddPetRaw - Add a new pet to the store
- DeletePet - Deletes a pet
- FindPetsByStatus - Finds Pets by status
- FindPetsByTags - Finds Pets by tags
- GetPetByID - Find pet by ID
- UpdatePetWithForm - Updates a pet in the store with form data
- UpdatePetForm - Update an existing pet
- UpdatePetJSON - Update an existing pet
- UpdatePetRaw - Update an existing pet
- UploadFile - uploads an image
- DeleteOrder - Delete purchase order by ID
- GetInventory - Returns pet inventories by status
- GetOrderByID - Find purchase order by ID
- PlaceOrderForm - Place an order for a pet
- PlaceOrderJSON - Place an order for a pet
- PlaceOrderRaw - Place an order for a pet
- CreateUserForm - Create user
- CreateUserJSON - Create user
- CreateUserRaw - Create user
- CreateUsersWithListInput - Creates list of users with given input array
- DeleteUser - Delete user
- GetUserByName - Get user by user name
- LoginUser - Logs user into the system
- LogoutUser - Logs out current logged in user session
- UpdateUserForm - Update user
- UpdateUserJSON - Update user
- UpdateUserRaw - Update user
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"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/sdkerrors"
"petstore/v3/pkg/models/shared"
)
func main() {
s := petstore.New(
petstore.WithSecurity("<YOUR_PETSTORE_AUTH_HERE>"),
)
request := shared.Pet{
Category: &shared.Category{
ID: petstore.Int64(1),
Name: petstore.String("Dogs"),
},
ID: petstore.Int64(10),
Name: "doggie",
PhotoUrls: []string{
"<value>",
},
}
ctx := context.Background()
res, err := s.Pet.AddPetForm(ctx, request)
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 | https:///api/v3 |
None |
package main
import (
"context"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/shared"
)
func main() {
s := petstore.New(
petstore.WithServerIndex(0),
petstore.WithSecurity("<YOUR_PETSTORE_AUTH_HERE>"),
)
request := shared.Pet{
Category: &shared.Category{
ID: petstore.Int64(1),
Name: petstore.String("Dogs"),
},
ID: petstore.Int64(10),
Name: "doggie",
PhotoUrls: []string{
"<value>",
},
}
ctx := context.Background()
res, err := s.Pet.AddPetForm(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.Pet != 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"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/shared"
)
func main() {
s := petstore.New(
petstore.WithServerURL("https:///api/v3"),
petstore.WithSecurity("<YOUR_PETSTORE_AUTH_HERE>"),
)
request := shared.Pet{
Category: &shared.Category{
ID: petstore.Int64(1),
Name: petstore.String("Dogs"),
},
ID: petstore.Int64(10),
Name: "doggie",
PhotoUrls: []string{
"<value>",
},
}
ctx := context.Background()
res, err := s.Pet.AddPetForm(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.Pet != 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 supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
PetstoreAuth |
oauth2 | OAuth2 token |
You can configure it using the WithSecurity option when initializing the SDK client instance. For example:
package main
import (
"context"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/shared"
)
func main() {
s := petstore.New(
petstore.WithSecurity("<YOUR_PETSTORE_AUTH_HERE>"),
)
request := shared.Pet{
Category: &shared.Category{
ID: petstore.Int64(1),
Name: petstore.String("Dogs"),
},
ID: petstore.Int64(10),
Name: "doggie",
PhotoUrls: []string{
"<value>",
},
}
ctx := context.Background()
res, err := s.Pet.AddPetForm(ctx, request)
if err != nil {
log.Fatal(err)
}
if res.Pet != nil {
// handle response
}
}Some operations in this SDK require the security scheme to be specified at the request level. For example:
package main
import (
"context"
"log"
petstore "petstore/v3"
"petstore/v3/pkg/models/operations"
)
func main() {
s := petstore.New()
request := operations.GetPetByIDRequest{
PetID: 504151,
}
security := operations.GetPetByIDSecurity{
APIKey: petstore.String("<YOUR_API_KEY_HERE>"),
}
ctx := context.Background()
res, err := s.Pet.GetPetByID(ctx, request, security)
if err != nil {
log.Fatal(err)
}
if res.Pet != nil {
// handle response
}
}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!