Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProblemDetails ¶
type ProblemDetails struct {
XMLName xml.Name `json:"-" xml:"urn:ietf:rfc:7807 problem"`
// Type is a URI reference [RFC3986] that identifies the
// problem type. This specification encourages that, when
// dereferenced, it provide human-readable documentation for the
// problem type (e.g., using HTML [W3C.REC-html5-20141028]). When
// this member is not present, its value is assumed to be
// "about:blank".
Type string `json:"type" xml:"type"`
// Title is a short, human-readable summary of the problem
// type. It SHOULD NOT change from occurrence to occurrence of the
// problem, except for purposes of localization (e.g., using
// proactive content negotiation; see [RFC7231], Section 3.4).
Title string `json:"title" xml:"title"`
// Status is the HTTP status code ([RFC7231], Section 6)
// generated by the origin server for this occurrence of the problem.
Status int `json:"status,omitempty" xml:"status,omitempty"`
// Detail is a human-readable explanation specific to this
// occurrence of the problem.
// If present, it ought to focus on helping the client
// correct the problem, rather than giving debugging information.
Detail string `json:"detail,omitempty" xml:"detail,omitempty"`
// Instance is a URI reference that identifies the specific
// occurrence of the problem. It may or may not yield further
// information if dereferenced.
Instance string `json:"instance,omitempty" xml:"instance,omitempty"`
}
ProblemDetails is the struct definition of a problem details object
func New ¶
func New(statusCode int, problemType, title, detail, instance string) *ProblemDetails
New creates a new ProblemDetails error
func NewHTTP ¶
func NewHTTP(statusCode int) *ProblemDetails
NewHTTP creates a new ProblemDetails error based just the HTTP Status Code
func (*ProblemDetails) Error ¶
func (pd *ProblemDetails) Error() string
Error implements the error interface
func (*ProblemDetails) ServeJSON ¶
func (p *ProblemDetails) ServeJSON(w http.ResponseWriter, r *http.Request) error
ServeJSON will output Problem Details json to the response writer
func (*ProblemDetails) ServeXML ¶
func (p *ProblemDetails) ServeXML(w http.ResponseWriter, r *http.Request) error
ServeXML will output Problem Details xml to the response writer
type ProblemType ¶
type ProblemType interface {
Error() string
}
ProblemType is an interface for problem type definitions. A ProblemType also implements the error interface
Click to show internal directories.
Click to hide internal directories.