stackpath

README

Go Client APIs for StackPath

These APIs are generated automatically from StackPath's OpenAPI specs for their APIs. (The one exception is their Monitoring (Legacy) API, which I skipped. I didn't think there was much justification for writing new client code in a new language but targeting a legacy interface.)

To recreate them or update them you will need OpenAPI Generator.

You can run make clean then make. There's no build of the libraries, since go get will just pull source anyway.

Since StackPath uses a collection of separate APIs, these are generated as separate packages.

Use these in your go project by running

go get gitlab.com/kraney/stackpath

or by getting an individual package, like

go get gitlab.com/kraney/stackpath/pkg/cdn

Detailed instructions for the APIs are in the generated output:

• Accounts and Users
• Sites
• SDN
• WAF
• DNS
• Edge Compute
• Edge Compute Networking
• SSL
• Monitoring
• Object Storage

Authentication

Note that the automatically generated documentation doesn't really mention authorization on the individual APIs, but for most of the APIs you will need to set the request header Authorization: Bearer <token> as described in StackPath's documentation.

The generated documentation on how to do this is a bit misleading. A golang.org/x/oauth2.TokenSource implementation has been provided to make it easier. This will automatically refresh the token when it expires.

Here's an example usage:

package main

import (
	"context"
	"flag"
	"log"

	spauth "github.com/kraney/stackpath/pkg/oauth2"
	"github.com/kraney/stackpath/pkg/stacks"
	"golang.org/x/oauth2"
)

func main() {
	clientid := flag.String("clientid", "", "client ID.")
	clientsecret := flag.String("secret", "", "client secret.")
	flag.Parse()

	var ts oauth2.TokenSource = spauth.NewTokenSource(*clientid, *clientsecret)
	auth := context.WithValue(context.Background(), stacks.ContextOAuth2, ts)
	stackclient := stacks.NewAPIClient(stacks.NewConfiguration())
    stacksresp, _, err := stackclient.StacksApi.GetStacks(auth).Execute()
	if err != nil {
		log.Fatalf("Error getting stacks list: %v", err)
	}
	log.Printf("%v", stacksresp.Results)
}

This TokenSource is also designed to facilitate use of GoVCR for testing.

    httpclient := govcr.NewVCR(testname, &govcr.VCRConfig{
		CassettePath:     "./testdata/recordings",
	}).Client
	var ts *spauth.TokenSource = spauth.NewTokenSource(*clientid, *clientsecret, spauth.HTTPClientOption(httpclient))
	auth := context.WithValue(context.Background(), stacks.ContextOAuth2, ts)