Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

rest

package

Go to main page

Versions in this module

v1

v1.1.5

Dec 17, 2025

v1.1.4

May 16, 2025

v1.1.3

May 9, 2025

v1.1.2

Nov 28, 2024

v1.1.2-rc1

Nov 22, 2024

v1.1.1

Jun 23, 2024

v1.1.0

May 6, 2024

v1.0.8

Jan 30, 2024

v1.0.7

Oct 12, 2023

v1.0.6

Mar 6, 2023

v1.0.5

Jan 27, 2023

v1.0.4

Sep 27, 2022

v1.0.3

Sep 16, 2022

v1.0.2

Jul 6, 2022

Changes in this version

+ const DefaultMaxHeaderBytes

+ var DefaultHTTPListenAddrs = []string

type Config

+ func NewConfig() *Config

v1.0.2-rc1

Jun 30, 2022

v0

v0.10.0

Mar 7, 2019

Changes in this version

type Config

+ func (cfg *Config) ApplyEnvVars() error

v0.10.0-rc1

Mar 4, 2019

v0.9.0

Feb 18, 2019

Changes in this version

type Config

+ Tracing bool

v0.9.0-rc1

Feb 12, 2019

v0.8.0

Jan 16, 2019

Changes in this version

+ var DefaultCORSAllowCredentials = true

+ var DefaultCORSAllowedHeaders = []string

+ var DefaultCORSAllowedMethods = []string

+ var DefaultCORSAllowedOrigins = []string

+ var DefaultCORSExposedHeaders = []string

+ var DefaultCORSMaxAge time.Duration

type Config

+ CORSAllowCredentials bool

+ CORSAllowedHeaders []string

+ CORSAllowedMethods []string

+ CORSAllowedOrigins []string

+ CORSExposedHeaders []string

+ CORSMaxAge time.Duration

v0.8.0-rc1

Jan 14, 2019

v0.7.0

Nov 1, 2018

Changes in this version

+ var DefaultHeaders = map[string][]string

type Config

+ Headers map[string][]string

v0.7.0-rc1

Oct 29, 2018

v0.6.0

Oct 3, 2018

v0.6.0-rc1

Oct 1, 2018

v0.5.0

Aug 24, 2018

v0.5.0-rc1

Aug 21, 2018

v0.4.0

May 30, 2018

v0.4.0-rc2

May 28, 2018

v0.4.0-rc1

May 14, 2018

v0.3.5

Mar 29, 2018

Changes in this version

+ const DefaultHTTPListenAddr

+ var ErrHTTPEndpointNotEnabled = errors.New("the HTTP endpoint is not enabled")

+ var ErrNoEndpointsEnabled = errors.New("neither the libp2p nor the HTTP endpoints are enabled")

type API

+ func NewAPIWithHost(cfg *Config, h host.Host) (*API, error)

+ func (api *API) Host() host.Host

type Config

+ HTTPListenAddr ma.Multiaddr

+ ID peer.ID

+ Libp2pListenAddr ma.Multiaddr

+ PrivateKey crypto.PrivKey

v0.3.5-rc1

Mar 26, 2018

v0.3.4

Feb 20, 2018

v0.3.3

Feb 12, 2018

Changes in this version

type API

+ func (api *API) HTTPAddress() string

v0.3.2

Jan 26, 2018

v0.3.1

Dec 11, 2017

v0.3.0

Nov 15, 2017

v0.2.1

Oct 26, 2017

v0.2.0

Oct 23, 2017

Changes in this version

+ const DefaultIdleTimeout

+ const DefaultListenAddr

+ const DefaultReadHeaderTimeout

+ const DefaultReadTimeout

+ const DefaultWriteTimeout

+ type API struct

+ func NewAPI(cfg *Config) (*API, error)

+ func (api *API) SetClient(c *rpc.Client)

+ func (api *API) Shutdown() error

+ type Config struct

+ BasicAuthCreds map[string]string

+ IdleTimeout time.Duration

+ ListenAddr ma.Multiaddr

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ TLS *tls.Config

+ WriteTimeout time.Duration

+ func (cfg *Config) ConfigKey() string

+ func (cfg *Config) Default() error

+ func (cfg *Config) LoadJSON(raw []byte) error

+ func (cfg *Config) ToJSON() (raw []byte, err error)

+ func (cfg *Config) Validate() error