Documentation
¶
Overview ¶
Package rest provides a framework for implementing a REST server.
Index ¶
- func BlankLineFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
- func ForbiddenFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
- func LogFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
- func NewTokenAuthFilter(token string) restful.FilterFunction
- func NoOpFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
- func ReadEntityOrBadRequest(readTo interface{}, request *restful.Request, response *restful.Response) bool
- func RecoverFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
- func RegisterSwagger(s *Server)
- func RespondOrDie(code int, entity interface{}, err error, response *restful.Response)
- func WriteValidationError(issueList api.IssueList, response *restful.Response)
- type HealthzResource
- type Resource
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BlankLineFilter ¶
func BlankLineFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
BlankLineFilter adds a blank line at the end of each request.
func ForbiddenFilter ¶
func ForbiddenFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
ForbiddenFilter blocks all requests.
func LogFilter ¶
func LogFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
LogFilter enriches the log with requenst/response data.
func NewTokenAuthFilter ¶
func NewTokenAuthFilter(token string) restful.FilterFunction
NewTokenAuthFilter only allows requests with the Header 'Authorization: "Bearer token"'.
func NoOpFilter ¶
func NoOpFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
NoOpFilter is a simple No-Op filter for go-restful.
func ReadEntityOrBadRequest ¶
func ReadEntityOrBadRequest(readTo interface{}, request *restful.Request, response *restful.Response) bool
ReadEntityOrBadRequest parses body of request into readTo and replies with a 400 error message on failure.
func RecoverFilter ¶
func RecoverFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
RecoverFilter captures a panic and responds with an API Error.
func RegisterSwagger ¶
func RegisterSwagger(s *Server)
RegisterSwagger exposes swagger definitions at /apidocs.json.
func RespondOrDie ¶
RespondOrDie is a convenience function for responding to a request. If given err is nil, this function writes the entity and code to the response. Otherwise err and its error code is written to the response. It panics on an unexpected error.
func WriteValidationError ¶
WriteValidationError creates an UnprocessableEntity Error and writes to response.
Types ¶
type HealthzResource ¶
type HealthzResource struct{}
HealthzResource is a REST resource for reporting health status.
func NewHealthzResource ¶
func NewHealthzResource() *HealthzResource
NewHealthzResource creates a new HealthzResource.
func (*HealthzResource) Register ¶
func (r *HealthzResource) Register(s *Server)
Register adds Resource to the provided Server.
type Resource ¶
type Resource interface {
Register(s *Server)
}
Resource is the interface of a REST Resource.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is a RESTful HTTP Server.
func NewStandardServer ¶
func NewStandardServer() *Server
NewStandardServer returns a preconfigured full-featured REST Server.
func (*Server) ListenAndServe ¶
ListenAndServe starts the HTTP Server and blocks.
Source Files
Directories