speakeasyclientsdkgo

README

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

SDK Installation

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

SDK Example Usage

package main

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

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

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

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

Available Resources and Operations

Speakeasy SDK

• ValidateAPIKey - Validate the current api key.

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.

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

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.

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.

Plugins

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

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.

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.

Dev Containers

Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!

• Explore Dev Containers

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

SDK Generated by Speakeasy

Documentation

Index

• Constants
• 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 SDKOption
  • func WithClient(client HTTPClient) SDKOption
  • func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
  • func WithSecurity(apiKey string) SDKOption
  • func WithServer(server string) SDKOption
  • func WithServerURL(serverURL string) SDKOption
  • func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
• type Speakeasy
  • func New(opts ...SDKOption) *Speakeasy
  • func (s *Speakeasy) ValidateAPIKey(ctx context.Context) (*operations.ValidateAPIKeyResponse, error)

Constants

const (
	ServerProd string = "prod"
)

Variables

var ServerList = map[string]string{
	ServerProd: "https://api.prod.speakeasyapi.dev",
}

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 SDKOption

type SDKOption func(*Speakeasy)

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 WithSecurity

func WithSecurity(apiKey string) SDKOption

func WithServer

func WithServer(server string) SDKOption

WithServer allows the overriding of the default server by name

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

type Speakeasy

type Speakeasy struct {
	// REST APIs for managing ApiEndpoint entities
	APIEndpoints *apiEndpoints
	// REST APIs for managing Api entities
	Apis *apis
	// REST APIs for managing embeds
	Embeds *embeds
	// REST APIs for managing Version Metadata entities
	Metadata *metadata
	// REST APIs for managing and running plugins
	Plugins *plugins
	// REST APIs for retrieving request information
	Requests *requests
	// REST APIs for managing Schema entities
	Schemas *schemas
	// contains filtered or unexported fields
}

Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs

/docs - The Speakeasy Platform Documentation

func New

func New(opts ...SDKOption) *Speakeasy

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

func (*Speakeasy) ValidateAPIKey

func (s *Speakeasy) ValidateAPIKey(ctx context.Context) (*operations.ValidateAPIKeyResponse, error)

ValidateAPIKey - Validate the current api key.