github.com/goadesign/goa/examples/calc/gen/http/openapi/server
server
import "github.com/goadesign/goa/examples/calc/gen/http/openapi/server"
Overview
Index
- func Mount(mux goahttp.Muxer)
- func MountGenHTTPOpenapiJSON(mux goahttp.Muxer, h http.Handler)
- type ErrorNamer
- type MountPoint
- type Server
- func New(e *openapi.Endpoints, mux goahttp.Muxer, dec func(*http.Request) goahttp.Decoder, enc func(context.Context, http.ResponseWriter) goahttp.Encoder, eh func(context.Context, http.ResponseWriter, error)) *Server
- func (s *Server) Service() string
- func (s *Server) Use(m func(http.Handler) http.Handler)
Package files
encode_decode.go paths.go server.go types.go
func Mount
func Mount(mux goahttp.Muxer)
Mount configures the mux to serve the openapi endpoints.
func MountGenHTTPOpenapiJSON
func MountGenHTTPOpenapiJSON(mux goahttp.Muxer, h http.Handler)
MountGenHTTPOpenapiJSON configures the mux to serve GET request made to “/swagger.json”.
type ErrorNamer
type ErrorNamer interface {
ErrorName() string
}
ErrorNamer is an interface implemented by generated error structs that exposes the name of the error as defined in the design.
type MountPoint
type MountPoint struct {
// Method is the name of the service method served by the mounted HTTP handler.
Method string
// Verb is the HTTP method used to match requests to the mounted handler.
Verb string
// Pattern is the HTTP request path pattern used to match requests to the
// mounted handler.
Pattern string
}
MountPoint holds information about the mounted endpoints.
type Server
type Server struct {
Mounts []*MountPoint
}
Server lists the openapi service endpoint HTTP handlers.
func New
func New(
e *openapi.Endpoints,
mux goahttp.Muxer,
dec func(*http.Request) goahttp.Decoder,
enc func(context.Context, http.ResponseWriter) goahttp.Encoder,
eh func(context.Context, http.ResponseWriter, error),
) *Server
New instantiates HTTP handlers for all the openapi service endpoints.
func (*Server) Service
func (s *Server) Service() string
Service returns the name of the service served.
func (*Server) Use
func (s *Server) Use(m func(http.Handler) http.Handler)
Use wraps the server handlers with the given middleware.
Generated by godoc2md