-
Notifications
You must be signed in to change notification settings - Fork 206
/
response.go
90 lines (76 loc) · 2.26 KB
/
response.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
// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
//
// This software (Documize Community Edition) is licensed under
// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
//
// You can operate outside the AGPL restrictions by purchasing
// Documize Enterprise Edition and obtaining a commercial license
// by contacting <sales@documize.com>.
//
// https://documize.com
package api
import (
"github.com/documize/community/wordsmith/log"
"encoding/json"
"net/http"
)
// apiJSONResponse is the structure of a JSON response to a Documize client.
type apiJSONResponse struct {
Code int
Success bool
Message string
Data interface{}
}
// SetJSONResponse sets the response type to "application/json" in the HTTP header.
func SetJSONResponse(w http.ResponseWriter) {
w.Header().Set("Content-Type", "application/json; charset=utf-8")
}
// WriteError to the http.ResponseWriter, taking care to provide the correct
// response error code within the JSON response.
func WriteError(w http.ResponseWriter, err error) {
response := apiJSONResponse{}
response.Message = err.Error()
response.Success = false
response.Data = nil
switch err.Error() {
case "BadRequest":
response.Code = 400
w.WriteHeader(http.StatusBadRequest)
case "Unauthorized":
response.Code = 401
w.WriteHeader(http.StatusUnauthorized)
case "Forbidden":
response.Code = 403
w.WriteHeader(http.StatusForbidden)
case "NotFound":
response.Code = 404
w.WriteHeader(http.StatusNotFound)
default:
response.Code = 500
w.WriteHeader(http.StatusInternalServerError)
}
json, err := json.Marshal(response)
if err != nil {
log.Error("json.Marshal", err)
}
if _, err := w.Write(json); err != nil {
log.Error("write to ResponseWriter", err)
}
}
// WriteErrorBadRequest provides feedback to a Documize client on an error,
// where that error is described in a string.
func WriteErrorBadRequest(w http.ResponseWriter, message string) {
response := apiJSONResponse{}
response.Message = message
response.Success = false
response.Data = nil
response.Code = 400
w.WriteHeader(http.StatusBadRequest)
json, err := json.Marshal(response)
if err != nil {
log.Error("json.Marshal", err)
}
if _, err := w.Write(json); err != nil {
log.Error("write to ResponseWriter", err)
}
}