README
¶
github.com/speakeasy-sdks-staging/test-private
🏗 Welcome to your new 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
SDK Installation
go get github.com/speakeasy-sdks-staging/test-private
SDK Example Usage
package main
import (
"context"
testprivate "github.com/speakeasy-sdks-staging/test-private"
"log"
)
func main() {
s := testprivate.New()
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx)
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
Error Handling
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.
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 |
For example:
package main
import (
"context"
testprivate "github.com/speakeasy-sdks-staging/test-private"
"log"
)
func main() {
s := testprivate.New(
testprivate.WithServerIndex(0),
)
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx)
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"
testprivate "github.com/speakeasy-sdks-staging/test-private"
"log"
)
func main() {
s := testprivate.New(
testprivate.WithServerURL("http://petstore.swagger.io/v1"),
)
ctx := context.Background()
res, err := s.Pets.CreatePets(ctx)
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 ¶
Constants ¶
This section is empty.
Variables ¶
var ServerList = []string{
"http://petstore.swagger.io/v1",
}
ServerList contains the list of servers available to the SDK
Functions ¶
Types ¶
type HTTPClient ¶
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) (*operations.CreatePetsResponse, error)
CreatePets - Create a pet
func (*Pets) ListPets ¶
func (s *Pets) ListPets(ctx context.Context, limit *int) (*operations.ListPetsResponse, error)
ListPets - List all pets
func (*Pets) ShowPetByID ¶
func (s *Pets) ShowPetByID(ctx context.Context, petID string) (*operations.ShowPetByIDResponse, error)
ShowPetByID - Info for a specific pet
type PrivateTest ¶
type PrivateTest struct {
Pets *Pets
// contains filtered or unexported fields
}
func New ¶
func New(opts ...SDKOption) *PrivateTest
New creates a new instance of the SDK with the provided options
type SDKOption ¶
type SDKOption func(*PrivateTest)
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 ¶
WithServerIndex allows the overriding of the default server by index
func WithServerURL ¶
WithServerURL allows the overriding of the default server URL
Source Files
Directories