Documentation
      ¶
    
    
  
    
  
    Index ¶
- type RestapiAPI
 - func (o *RestapiAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
 - func (o *RestapiAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
 - func (o *RestapiAPI) Authorizer() runtime.Authorizer
 - func (o *RestapiAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
 - func (o *RestapiAPI) Context() *middleware.Context
 - func (o *RestapiAPI) DefaultConsumes() string
 - func (o *RestapiAPI) DefaultProduces() string
 - func (o *RestapiAPI) Formats() strfmt.Registry
 - func (o *RestapiAPI) HandlerFor(method, path string) (http.Handler, bool)
 - func (o *RestapiAPI) Init()
 - func (o *RestapiAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
 - func (o *RestapiAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
 - func (o *RestapiAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
 - func (o *RestapiAPI) RegisterProducer(mediaType string, producer runtime.Producer)
 - func (o *RestapiAPI) Serve(builder middleware.Builder) http.Handler
 - func (o *RestapiAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
 - func (o *RestapiAPI) SetDefaultConsumes(mediaType string)
 - func (o *RestapiAPI) SetDefaultProduces(mediaType string)
 - func (o *RestapiAPI) SetSpec(spec *loads.Document)
 - func (o *RestapiAPI) UseRedoc()
 - func (o *RestapiAPI) UseSwaggerUI()
 - func (o *RestapiAPI) Validate() error
 
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type RestapiAPI ¶
type RestapiAPI struct {
	Middleware func(middleware.Builder) http.Handler
	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer
	// ApplicationZipProducer registers a producer for the following mime types:
	//   - application/zip
	ApplicationZipProducer runtime.Producer
	// BasicAuthAuth registers a function that takes username and password and returns a principal
	// it performs authentication with basic auth
	BasicAuthAuth func(string, string) (*models.Principal, error)
	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer
	// ApIsAllGetApisHandler sets the operation handler for the get apis operation
	ApIsAllGetApisHandler a_p_is_all.GetApisHandler
	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)
	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()
	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()
	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup
	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}
    RestapiAPI This document specifies a **RESTful API** for allowing you to access internal data . Please see [full swagger definition](https://raw.githubusercontent.com/wso2/carbon-apimgt/master/components/apimgt/org.wso2.carbon.apimgt.internal.service/src/main/resources/api.yaml) of the API which is written using [swagger 2.0](http://swagger.io/) specification.
func NewRestapiAPI ¶
func NewRestapiAPI(spec *loads.Document) *RestapiAPI
NewRestapiAPI creates a new Restapi instance
func (*RestapiAPI) AddMiddlewareFor ¶
func (o *RestapiAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*RestapiAPI) AuthenticatorsFor ¶
func (o *RestapiAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*RestapiAPI) Authorizer ¶
func (o *RestapiAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*RestapiAPI) ConsumersFor ¶
func (o *RestapiAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*RestapiAPI) Context ¶
func (o *RestapiAPI) Context() *middleware.Context
Context returns the middleware context for the restapi API
func (*RestapiAPI) DefaultConsumes ¶
func (o *RestapiAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*RestapiAPI) DefaultProduces ¶
func (o *RestapiAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*RestapiAPI) Formats ¶
func (o *RestapiAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*RestapiAPI) HandlerFor ¶
func (o *RestapiAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*RestapiAPI) Init ¶
func (o *RestapiAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*RestapiAPI) ProducersFor ¶
func (o *RestapiAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*RestapiAPI) RegisterConsumer ¶
func (o *RestapiAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*RestapiAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*RestapiAPI) RegisterProducer ¶
func (o *RestapiAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*RestapiAPI) Serve ¶
func (o *RestapiAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*RestapiAPI) ServeErrorFor ¶
func (o *RestapiAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*RestapiAPI) SetDefaultConsumes ¶
func (o *RestapiAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*RestapiAPI) SetDefaultProduces ¶
func (o *RestapiAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*RestapiAPI) SetSpec ¶
func (o *RestapiAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*RestapiAPI) UseSwaggerUI ¶
func (o *RestapiAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*RestapiAPI) Validate ¶
func (o *RestapiAPI) Validate() error
Validate validates the registrations in the RestapiAPI