api

package

v0.0.0-...-8eaf68a Latest Latest Go to latest Published: Mar 20, 2017 License: MIT Imports: 46 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

Repository

github.com/cpacia/openbazaar-go

Links

Open Source Insights

Documentation ¶

Index ¶

func ErrorResponse(w http.ResponseWriter, errorCode int, reason string)
func SanitizeJSON(s []byte) ([]byte, error)
func SanitizedResponse(w http.ResponseWriter, response string)
func SanitizedResponseM(w http.ResponseWriter, response string, m proto.Message)
type Gateway
- func NewGateway(n *core.OpenBazaarNode, authCookie http.Cookie, l net.Listener, ...) (*Gateway, error)
- func (g *Gateway) Close() error
- func (g *Gateway) Serve() error
type JsonAPIConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ErrorResponse ¶

func ErrorResponse(w http.ResponseWriter, errorCode int, reason string)

func SanitizeJSON ¶

func SanitizeJSON(s []byte) ([]byte, error)

func SanitizedResponse ¶

func SanitizedResponse(w http.ResponseWriter, response string)

func SanitizedResponseM ¶

func SanitizedResponseM(w http.ResponseWriter, response string, m proto.Message)

Types ¶

type Gateway ¶

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

Gateway represents an HTTP API gateway

func NewGateway ¶

func NewGateway(n *core.OpenBazaarNode, authCookie http.Cookie, l net.Listener, config repo.APIConfig, options ...corehttp.ServeOption) (*Gateway, error)

NewGateway instantiates a new `Gateway`

func (*Gateway) Close ¶

func (g *Gateway) Close() error

Close shutsdown the Gateway listener

func (*Gateway) Serve ¶

func (g *Gateway) Serve() error

Serve begins listening on the configured address

type JsonAPIConfig ¶

type JsonAPIConfig struct {
	Headers       map[string][]string
	Enabled       bool
	Cors          *string
	Authenticated bool
	AllowedIPs    map[string]bool
	Cookie        http.Cookie
	Username      string
	Password      string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
notifications

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL