-
Notifications
You must be signed in to change notification settings - Fork 2
/
problemdetails.go
99 lines (89 loc) · 3.39 KB
/
problemdetails.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
package problemdetails
import (
"encoding/json"
"encoding/xml"
"fmt"
"net/http"
)
// ProblemDetails is the struct definition of a problem details object
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"`
}
// Error implements the error interface
func (pd *ProblemDetails) Error() string {
if pd.Title == "" && pd.Detail == "" {
return fmt.Sprintf("Status %d", pd.Status)
}
if pd.Detail == "" {
return fmt.Sprintf("%s", pd.Title)
}
return fmt.Sprintf("%s: %s", pd.Title, pd.Detail)
}
// New creates a new ProblemDetails error
func New(statusCode int, problemType, title, detail, instance string) *ProblemDetails {
// When this member is not present, its value is assumed to be
// "about:blank".
if problemType == "" {
problemType = "about:blank"
}
// When "about:blank" is used, the title SHOULD be the same as the
// recommended HTTP status phrase for that code (e.g., "Not Found" for
// 404, and so on), although it MAY be localized to suit client
// preferences (expressed with the Accept-Language request header).
if problemType == "about:blank" {
title = http.StatusText(statusCode)
}
return &ProblemDetails{
Type: problemType,
Title: title,
Status: statusCode,
Detail: detail,
Instance: instance,
}
}
// NewHTTP creates a new ProblemDetails error based just the HTTP Status Code
func NewHTTP(statusCode int) *ProblemDetails {
return New(statusCode, "", "", "", "")
}
// ServeJSON will output Problem Details json to the response writer
func (p *ProblemDetails) ServeJSON(w http.ResponseWriter, r *http.Request) error {
w.Header().Set("Content-Type", "application/problem+json")
w.WriteHeader(p.Status)
if err := json.NewEncoder(w).Encode(p); err != nil {
return err
}
return nil
}
// ServeXML will output Problem Details xml to the response writer
func (p *ProblemDetails) ServeXML(w http.ResponseWriter, r *http.Request) error {
w.Header().Set("Content-Type", "application/problem+xml")
w.WriteHeader(p.Status)
if err := xml.NewEncoder(w).Encode(p); err != nil {
return err
}
return nil
}