service

package main

import (
	"fmt"
	"net/url"

	"github.com/splunk/go-splunk-client/pkg/service"
)

// Title is a string that uniquely identifies a resource.
type Title string

// GetServicePath implements custom GetServicePath encoding. It returns the given
// path back, which has the effect of using the Title field's struct tag as
// its GetServicePath.
func (t Title) GetServicePath(path string) (string, error) {
	return path, nil
}

// GetEntryPath implements custom GetEntryPath encoding. It returns the url-encoded
// value of the Title with the given path preceding it.
func (t Title) GetEntryPath(path string) (string, error) {
	servicePath, err := t.GetServicePath(path)
	if err != nil {
		return "", err
	}

	return fmt.Sprintf("%s/%s", servicePath, url.PathEscape(string(t))), nil
}

// Artist represents a musical artist.
type Artist struct {
	// Name is a Title which determines both the ServicePath (music/artists)
	// and EntryPath (music/artists/<Title>).
	Name Title `service:"music/artists"`
}

func main() {
	newArtist := Artist{Name: "The Refreshments"}

	servicePath, _ := service.ServicePath(newArtist)
	fmt.Printf("path to create Artist: %s\n", servicePath)
	entryPath, _ := service.EntryPath(newArtist)
	fmt.Printf("path to existing Artist: %s\n", entryPath)
}

Output:

path to create Artist: music/artists
path to existing Artist: music/artists/The%20Refreshments