testpetstore

README

github.com/speakeasy-sdks/test-petstore

SDK Installation

go get github.com/speakeasy-sdks/test-petstore

SDK Example Usage

Example

package main

import (
	"context"
	testpetstore "github.com/speakeasy-sdks/test-petstore"
	"github.com/speakeasy-sdks/test-petstore/pkg/models/shared"
	"log"
	"net/http"
)

func main() {
	s := testpetstore.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
	}
}

Available Resources and Operations

Pets

• CreatePets - Create a pet
• ListPets - List all pets
• ShowPetByID - Info for a specific pet

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.SDKError	4xx-5xx	/

Example

package main

import (
	"context"
	"errors"
	testpetstore "github.com/speakeasy-sdks/test-petstore"
	"github.com/speakeasy-sdks/test-petstore/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/test-petstore/pkg/models/shared"
	"log"
)

func main() {
	s := testpetstore.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())
		}
	}
}

Server Selection

Select Server by Index

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

Example

package main

import (
	"context"
	testpetstore "github.com/speakeasy-sdks/test-petstore"
	"github.com/speakeasy-sdks/test-petstore/pkg/models/shared"
	"log"
	"net/http"
)

func main() {
	s := testpetstore.New(
		testpetstore.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
	}
}

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:

package main

import (
	"context"
	testpetstore "github.com/speakeasy-sdks/test-petstore"
	"github.com/speakeasy-sdks/test-petstore/pkg/models/shared"
	"log"
	"net/http"
)

func main() {
	s := testpetstore.New(
		testpetstore.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
	}
}

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:

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.

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

Documentation

Index

• Variables
• func Bool(b bool) *bool
• func Float32(f float32) *float32
• func Float64(f float64) *float64
• func Int(i int) *int
• func Int64(i int64) *int64
• func String(s string) *string
• type HTTPClient
• type Pets
  • func (s *Pets) CreatePets(ctx context.Context, request shared.Pet) (*operations.CreatePetsResponse, error)
  • func (s *Pets) ListPets(ctx context.Context, request operations.ListPetsRequest) (*operations.ListPetsResponse, error)
  • func (s *Pets) ShowPetByID(ctx context.Context, request operations.ShowPetByIDRequest) (*operations.ShowPetByIDResponse, error)
• type Petstore
  • func New(opts ...SDKOption) *Petstore
• type SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
  • func WithServerIndex(serverIndex int) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

Variables

var ServerList = []string{
	"http://petstore.swagger.io/v1",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type Pets

type Pets struct {
	// contains filtered or unexported fields
}

func (*Pets) CreatePets

func (s *Pets) CreatePets(ctx context.Context, request shared.Pet) (*operations.CreatePetsResponse, error)

CreatePets - Create a pet

func (*Pets) ListPets

func (s *Pets) ListPets(ctx context.Context, request operations.ListPetsRequest) (*operations.ListPetsResponse, error)

ListPets - List all pets

func (*Pets) ShowPetByID

func (s *Pets) ShowPetByID(ctx context.Context, request operations.ShowPetByIDRequest) (*operations.ShowPetByIDResponse, error)

ShowPetByID - Info for a specific pet

type Petstore

type Petstore struct {
	Pets *Pets
	// contains filtered or unexported fields
}

func New

func New(opts ...SDKOption) *Petstore

New creates a new instance of the SDK with the provided options

type SDKOption

type SDKOption func(*Petstore)

func WithClient

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig

func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption

func WithServerIndex

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters