Documentation
¶
Index ¶
- type ServiceAPI
- func (o *ServiceAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *ServiceAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *ServiceAPI) Authorizer() runtime.Authorizer
- func (o *ServiceAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *ServiceAPI) Context() *middleware.Context
- func (o *ServiceAPI) DefaultConsumes() string
- func (o *ServiceAPI) DefaultProduces() string
- func (o *ServiceAPI) Formats() strfmt.Registry
- func (o *ServiceAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *ServiceAPI) Init()
- func (o *ServiceAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *ServiceAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *ServiceAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *ServiceAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *ServiceAPI) Serve(builder middleware.Builder) http.Handler
- func (o *ServiceAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *ServiceAPI) SetDefaultConsumes(mediaType string)
- func (o *ServiceAPI) SetDefaultProduces(mediaType string)
- func (o *ServiceAPI) SetSpec(spec *loads.Document)
- func (o *ServiceAPI) UseRedoc()
- func (o *ServiceAPI) UseSwaggerUI()
- func (o *ServiceAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ServiceAPI ¶
type ServiceAPI struct { FrontendGetFrontendSliderHandler frontend.GetFrontendSliderHandler FrontendGetFrontendUsersHandler frontend.GetFrontendUsersHandler FrontendGetFrontendBlogSlugHandler frontend.GetFrontendBlogSlugHandler FrontendGetFrontendCategoriesHandler frontend.GetFrontendCategoriesHandler FrontendPostFrontendContactFormHandler frontend.PostFrontendContactFormHandler CdnPostFrontendCdnHandler cdn.PostFrontendCdnHandler AuthPostFrontendAuthWalletConnectHandler auth.PostFrontendAuthWalletConnectHandler PublicGetPingHandler public.GetPingHandler MonitoringGetMetricsHandler monitoring.GetMetricsHandler FrontendGetFrontendWalletConnectHandler frontend.GetFrontendWalletConnectHandler FrontendGetFrontendPageSlugHandler frontend.GetFrontendPageSlugHandler FrontendGetFrontendMenuHandler frontend.GetFrontendMenuHandler JSONConsumer runtime.Consumer MultipartformConsumer runtime.Consumer JSONProducer runtime.Producer FrontendGetFrontendHelpCenterHandler frontend.GetFrontendHelpCenterHandler FrontendGetFrontendFilesFileHandler frontend.GetFrontendFilesFileHandler APIAuthorizer runtime.Authorizer AuthGetFrontendAuthCallbackHandler auth.GetFrontendAuthCallbackHandler AuthGetFrontendAuthWalletConnectHandler auth.GetFrontendAuthWalletConnectHandler FrontendGetFrontendBlogHandler frontend.GetFrontendBlogHandler FrontendGetFrontendFaqHandler frontend.GetFrontendFaqHandler CdnPutFrontendCdnHandler cdn.PutFrontendCdnHandler FrontendGetFrontendCreateAndSellHandler frontend.GetFrontendCreateAndSellHandler FrontendGetFrontendContactHandler frontend.GetFrontendContactHandler FrontendGetFrontendContractsHandler frontend.GetFrontendContractsHandler CdnGetFrontendCdnHandler cdn.GetFrontendCdnHandler ServerShutdown func() BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator Middleware func(middleware.Builder) http.Handler Logger func(string, ...interface{}) BearerAuth func(string) (*models.Principal, error) XTokenAuth func(string) (*models.Principal, error) PreServerShutdown func() ServeError func(http.ResponseWriter, *http.Request, error) CommandLineOptionsGroups []swag.CommandLineOptionsGroup // contains filtered or unexported fields }
ServiceAPI The Plutonium Service API provides endpoints to support the operations of the NFT Marketplace. This document outlines the API's structure, response formats, and capabilities for integration.
func NewServiceAPI ¶
func NewServiceAPI(spec *loads.Document) *ServiceAPI
NewServiceAPI creates a new Service instance
func (*ServiceAPI) AddMiddlewareFor ¶
func (o *ServiceAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*ServiceAPI) AuthenticatorsFor ¶
func (o *ServiceAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*ServiceAPI) Authorizer ¶
func (o *ServiceAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*ServiceAPI) ConsumersFor ¶
func (o *ServiceAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*ServiceAPI) Context ¶
func (o *ServiceAPI) Context() *middleware.Context
Context returns the middleware context for the service API
func (*ServiceAPI) DefaultConsumes ¶
func (o *ServiceAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*ServiceAPI) DefaultProduces ¶
func (o *ServiceAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*ServiceAPI) Formats ¶
func (o *ServiceAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*ServiceAPI) HandlerFor ¶
func (o *ServiceAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*ServiceAPI) Init ¶
func (o *ServiceAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*ServiceAPI) ProducersFor ¶
func (o *ServiceAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*ServiceAPI) RegisterConsumer ¶
func (o *ServiceAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*ServiceAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*ServiceAPI) RegisterProducer ¶
func (o *ServiceAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*ServiceAPI) Serve ¶
func (o *ServiceAPI) 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 (*ServiceAPI) ServeErrorFor ¶
func (o *ServiceAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*ServiceAPI) SetDefaultConsumes ¶
func (o *ServiceAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*ServiceAPI) SetDefaultProduces ¶
func (o *ServiceAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*ServiceAPI) SetSpec ¶
func (o *ServiceAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*ServiceAPI) UseSwaggerUI ¶
func (o *ServiceAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*ServiceAPI) Validate ¶
func (o *ServiceAPI) Validate() error
Validate validates the registrations in the ServiceAPI