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

common

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

Changes in this version

type API

+ func (api *API) HealthHandler(w http.ResponseWriter, r *http.Request)

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 SetStatusAutomatically

+ const StreamChannelSize

+ 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 struct

+ func NewAPI(ctx context.Context, cfg *Config, routes func(*rpc.Client) []Route) (*API, error)

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

+ func (api *API) Context() context.Context

+ func (api *API) GenerateTokenHandler(w http.ResponseWriter, r *http.Request)

+ func (api *API) HTTPAddresses() ([]string, error)

+ func (api *API) Headers() map[string][]string

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

+ func (api *API) ParseCidOrFail(w http.ResponseWriter, r *http.Request) types.Pin

+ func (api *API) ParsePidOrFail(w http.ResponseWriter, r *http.Request) peer.ID

+ func (api *API) ParsePinPathOrFail(w http.ResponseWriter, r *http.Request) types.PinPath

+ func (api *API) SendResponse(w http.ResponseWriter, status int, err error, resp interface{})

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

+ func (api *API) SetHeaders(w http.ResponseWriter)

+ func (api *API) SetKeepAlivesEnabled(b bool)

+ func (api *API) Shutdown(ctx context.Context) error

+ func (api *API) StreamResponse(w http.ResponseWriter, next StreamIterator, errCh chan error)

+ type Config struct

+ APIErrorFunc func(err error, status int) error

+ BasicAuthCredentials map[string]string

+ CORSAllowCredentials bool

+ CORSAllowedHeaders []string

+ CORSAllowedMethods []string

+ CORSAllowedOrigins []string

+ CORSExposedHeaders []string

+ CORSMaxAge time.Duration

+ ConfigKey string

+ DefaultFunc func(*Config) error

+ EnvConfigKey string

+ HTTPListenAddr []ma.Multiaddr

+ HTTPLogFile string

+ Headers map[string][]string

+ ID peer.ID

+ IdleTimeout time.Duration

+ Libp2pListenAddr []ma.Multiaddr

+ Logger *logging.ZapEventLogger

+ MaxHeaderBytes int

+ PathSSLCertFile string

+ PathSSLKeyFile string

+ PrivateKey crypto.PrivKey

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ RequestLogger *logging.ZapEventLogger

+ TLS *tls.Config

+ Tracing bool

+ WriteTimeout time.Duration

+ func (cfg *Config) ApplyEnvVars() error

+ func (cfg *Config) CorsOptions() *cors.Options

+ func (cfg *Config) GetHTTPLogPath() string

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

+ func (cfg *Config) LogWriter() (io.Writer, error)

+ func (cfg *Config) ToDisplayJSON() ([]byte, error)

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

+ func (cfg *Config) Validate() error

+ type Route struct

+ HandlerFunc http.HandlerFunc

+ Method string

+ Name string

+ Pattern string

+ type StreamIterator func() (interface{}, bool, error)

v1.0.2-rc1

Jun 30, 2022