api

package

v0.1.9 Latest Latest Go to latest Published: Feb 7, 2019 License: Apache-2.0, BSD-3-Clause, MIT Imports: 22 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/ablease/service-manager

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api contains logic for building the Service Manager API business logic

Index ¶

func New(ctx context.Context, repository storage.Repository, settings *Settings, ...) (*web.API, error)
type HTTPHandler
- func NewHTTPHandler(handler web.Handler, requestBodyMaxSize int) *HTTPHandler
- func (h *HTTPHandler) Handle(req *web.Request) (resp *web.Response, err error)
- func (h *HTTPHandler) ServeHTTP(res http.ResponseWriter, req *http.Request)
type Settings
- func DefaultSettings() *Settings
- func (s *Settings) Validate() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(ctx context.Context, repository storage.Repository, settings *Settings, encrypter security.Encrypter) (*web.API, error)

New returns the minimum set of REST APIs needed for the Service Manager

Types ¶

type HTTPHandler ¶

type HTTPHandler struct {
	Handler web.Handler
	// contains filtered or unexported fields
}

HTTPHandler converts a pkg/web.Handler and pkg/web.HandlerFunc to a standard http.Handler

func NewHTTPHandler ¶

func NewHTTPHandler(handler web.Handler, requestBodyMaxSize int) *HTTPHandler

NewHTTPHandler creates a new HTTPHandler from the provided web.Handler

func (*HTTPHandler) Handle ¶

func (h *HTTPHandler) Handle(req *web.Request) (resp *web.Response, err error)

Handle implements the web.Handler interface

func (*HTTPHandler) ServeHTTP ¶

func (h *HTTPHandler) ServeHTTP(res http.ResponseWriter, req *http.Request)

ServeHTTP implements the http.Handler interface and allows wrapping web.Handlers into http.Handlers

type Settings ¶

type Settings struct {
	TokenIssuerURL    string `mapstructure:"token_issuer_url"`
	ClientID          string `mapstructure:"client_id"`
	SkipSSLValidation bool   `mapstructure:"skip_ssl_validation"`
	TokenBasicAuth    bool   `mapstructure:"token_basic_auth"`
}

Settings type to be loaded from the environment

func DefaultSettings ¶

func DefaultSettings() *Settings

DefaultSettings returns default values for API settings

func (*Settings) Validate ¶

func (s *Settings) Validate() error

Validate validates the API settings

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
broker Package broker contains logic for building the Service Manager Broker Management API	Package broker contains logic for building the Service Manager Broker Management API
filters
authn/basic
authn/oauth
healthcheck Package healthcheck contains logic for the Service Manager healthcheck API	Package healthcheck contains logic for the Service Manager healthcheck API
info Package info contains logic for the Service Manager info API	Package info contains logic for the Service Manager info API
osb Package osb contains logic for building the Service Manager OSB API	Package osb contains logic for building the Service Manager OSB API
platform Package platform contains logic for the Service Manager Platform Management API	Package platform contains logic for the Service Manager Platform Management API
service_offering Package service_offering contains logic for building the Service Manager service offerings API	Package service_offering contains logic for building the Service Manager service offerings API
service_plan Package service_plan contains logic for building the Service Manager service plans API	Package service_plan contains logic for building the Service Manager service plans API
visibility Package visibility contains logic for building the Service Manager visibilities API	Package visibility contains logic for building the Service Manager visibilities API

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