apid

package module

v0.0.0-...-08db9f4 Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Friendlier UIUDs for APIs

APIDs are Base62 encoded UUIDs with a string prefix

Before: "ce5cc4ed-0201-4bd9-82b8-27ece33bce6b"

After: "user_6hoOwWlutwzIKWFCp54MUb"

View Source

const DefaultSeparator = "_"

View Source

var (
	ErrInvalidAPID      = fmt.Errorf("invalid APID")
	ErrInvalidSeparator = fmt.Errorf("invalid APID separator")
)

This section is empty.

type APID struct {
	Prefix string
	UUID   uuid.UUID
	// contains filtered or unexported fields
}

func New(prefix string) *APID

func Parse(s string) (*APID, error)

Example ¶

a, _ := Parse("test_6hoOwWlutwzIKWFCp54MUb")

Output:

test ce5cc4ed-0201-4bd9-82b8-27ece33bce6b

func WithSeparator(s string, a APID) (*APID, error)

func (a APID) Separator() string

func (a APID) String() string

Path	Synopsis
cmd
apid