Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

requestmigrations

package module

Go to main page

Versions in this module

v0

v0.6.0

Oct 23, 2024

Changes in this version

type RequestMigration

+ func (rm *RequestMigration) WriteVersionHeader() func(next http.Handler) http.Handler

v0.5.0

Mar 27, 2024

Changes in this version

type RequestMigration

+ func (rm *RequestMigration) Migrate(r *http.Request, handler string) (error, *response, rollbackFn)

v0.4.0

Jan 16, 2024

Changes in this version

+ type MigrationStore map[string]Migrations

v0.3.0

Dec 23, 2023

Changes in this version

+ var ErrCurrentVersionCannotBeEmpty = errors.New("Current Version field cannot be empty")

+ func Newmigrator(from, to *Version, avs []*Version, migrations Migrations) (*migrator, error)

+ type GetUserVersionFunc func(req *http.Request) (string, error)

type Migration

+ Migrate func(data []byte, header http.Header) ([]byte, http.Header, error)

+ ShouldMigrateConstraint func(url *url.URL, method string, data []byte, isReq bool) bool

type RequestMigration

+ func (rm *RequestMigration) RegisterMetrics(reg *prometheus.Registry)

+ func (rm *RequestMigration) VersionRequest(r *http.Request) error

+ func (rm *RequestMigration) VersionResponse(r *http.Request, body []byte) ([]byte, error)

type RequestMigrationOptions

+ GetUserVersionFunc GetUserVersionFunc

v0.2.0

Sep 15, 2023

v0.1.0

Sep 12, 2023

Changes in this version

+ var ErrInvalidVersion = errors.New("Invalid version number")

+ var ErrInvalidVersionFormat = errors.New("Invalid version format")

+ var ErrServerError = errors.New("Server error")

+ type GetUserHeaderFunc func(req *http.Request) (string, error)

+ type Migration interface

+ MigrateRequest func(req *http.Request) error

+ MigrateResponse func(res *http.Response) error

+ ShouldMigrateRequest func(req *http.Request) bool

+ ShouldMigrateResponse func(req *http.Request, res *http.Response) bool

+ type Migrations map[string][]Migration

+ type Migrator struct

+ func NewMigrator(from, to *Version, avs []*Version, migrations Migrations) (*Migrator, error)

+ type RequestMigration struct

+ Metric *prometheus.HistogramVec

+ func NewRequestMigration(opts *RequestMigrationOptions) (*RequestMigration, error)

+ func (rm *RequestMigration) RegisterMigrations(migrations Migrations) error

+ func (rm *RequestMigration) VersionAPI(next http.Handler) http.Handler

+ type RequestMigrationOptions struct

+ CurrentVersion string

+ GetUserHeaderFunc GetUserHeaderFunc

+ VersionFormat VersionFormat

+ VersionHeader string

+ type Version struct

+ Format VersionFormat

+ Value interface{}

+ func (v *Version) Equal(vv *Version) bool

+ func (v *Version) IsValid() bool

+ func (v *Version) String() string

+ type VersionFormat string

+ const DateFormat

+ const SemverFormat