github.com/speakeasy-api/speakeasy-client-sdk-go

SDK Installation

go get github.com/speakeasy-api/speakeasy-client-sdk-go

SDK Example Usage

Example

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v2"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/operations"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.Apis.GetApis(ctx, operations.GetApisRequest{
		Metadata: map[string][]string{
			"key": []string{
				"string",
			},
		},
		Op: &operations.QueryParamOp{
			And: false,
		},
	})
	if err != nil {
		log.Fatal(err)
	}

	if res.Classes != nil {
		// handle response
	}
}

Available Resources and Operations

Speakeasy SDK

• ValidateAPIKey - Validate the current api key.

Apis

• DeleteAPI - Delete an Api.
• GenerateOpenAPISpec - Generate an OpenAPI specification for a particular Api.
• GeneratePostmanCollection - Generate a Postman collection for a particular Api.
• GetAllAPIVersions - Get all Api versions for a particular ApiEndpoint.
• GetApis - Get a list of Apis for a given workspace
• UpsertAPI - Upsert an Api

APIEndpoints

• DeleteAPIEndpoint - Delete an ApiEndpoint.
• FindAPIEndpoint - Find an ApiEndpoint via its displayName.
• GenerateOpenAPISpecForAPIEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
• GeneratePostmanCollectionForAPIEndpoint - Generate a Postman collection for a particular ApiEndpoint.
• GetAllAPIEndpoints - Get all Api endpoints for a particular apiID.
• GetAllForVersionAPIEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
• GetAPIEndpoint - Get an ApiEndpoint.
• UpsertAPIEndpoint - Upsert an ApiEndpoint.

Metadata

• DeleteVersionMetadata - Delete metadata for a particular apiID and versionID.
• GetVersionMetadata - Get all metadata for a particular apiID and versionID.
• InsertVersionMetadata - Insert metadata for a particular apiID and versionID.

Schemas

• DeleteSchema - Delete a particular schema revision for an Api.
• DownloadSchema - Download the latest schema for a particular apiID.
• DownloadSchemaRevision - Download a particular schema revision for an Api.
• GetSchema - Get information about the latest schema.
• GetSchemaDiff - Get a diff of two schema revisions for an Api.
• GetSchemaRevision - Get information about a particular schema revision for an Api.
• GetSchemas - Get information about all schemas associated with a particular apiID.
• RegisterSchema - Register a schema.

Requests

• GenerateRequestPostmanCollection - Generate a Postman collection for a particular request.
• GetRequestFromEventLog - Get information about a particular request.
• QueryEventLog - Query the event log to retrieve a list of requests.

Plugins

• GetPlugins - Get all plugins for the current workspace.
• RunPlugin - Run a plugin
• UpsertPlugin - Upsert a plugin

Embeds

• GetEmbedAccessToken - Get an embed access token for the current workspace.
• GetValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
• RevokeEmbedAccessToken - Revoke an embed access EmbedToken.

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.

Example

package main

import (
	"context"
	"errors"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v2"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/sdkerrors"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/shared"
	"log"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ValidateAPIKey(ctx)
	if err != nil {

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Name

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:

Example

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v2"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/shared"
	"log"
	"net/http"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServer("prod"),
		speakeasyclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ValidateAPIKey(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"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v2"
	"github.com/speakeasy-api/speakeasy-client-sdk-go/v2/pkg/models/shared"
	"log"
	"net/http"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithServerURL("https://api.prod.speakeasyapi.dev"),
		speakeasyclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ValidateAPIKey(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.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v2"
	"log"
	"net/http"
)

func main() {
	s := speakeasyclientsdkgo.New(
		speakeasyclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
	)

	ctx := context.Background()
	res, err := s.ValidateAPIKey(ctx)
	if err != nil {
		log.Fatal(err)
	}

	if res.StatusCode == http.StatusOK {
		// handle response
	}
}

SDK Generated by Speakeasy