token

README

An example implementation of using a continuation token for API paging

Inspired by:

• https://blog.philipphauer.de/web-api-pagination-timestamp-id-continuation-token
• http://blog.vermorel.com/journal/2015/5/8/nearly-all-web-apis-get-paging-wrong.html

To run...

# one session
docker-compose up

# another
go test

Possible improvements:

• create a client/server with headers to indicate continuation token
• play around with isolation levels in postgres transactions to expose possible phantom or nonrepeatable read

Documentation

Index

• type Foo
• type FooPlusToken
• type Token
  • func NewToken() *Token

Types

type Foo

type Foo struct {
	ID        int       `db:"id" json:"id"`
	Data      string    `db:"data" json:"data"`
	CreatedAt time.Time `db:"created_at" json:"createdAt"`
	UpdatedAt time.Time `db:"updated_at" json:"updatedAt"`
}

Foo is the best data type

type FooPlusToken

type FooPlusToken struct {
	Foo       []Foo  `json:"foo"`
	LastToken string `json:"lastToken"`
	NewToken  string `json:"newToken"`
}

FooPlusToken is for serializing Foo and the token

type Token

type Token struct {
	// contains filtered or unexported fields
}

Token is a simple struct for the db and default limit

func NewToken

func NewToken() *Token

NewToken creates a Token instance