Preston_PLB
/
jsonapi
forked from Mirrors/jsonapi
1
0
Fork 0
Code Pull Requests Activity

Use constants for status codes, HTTP methods and JSON API media types in comments and readme

This commit is contained in:
Aren Patel 2017-01-20 18:06:44 -08:00
parent 46a5b96356
commit 15abc3066a
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -229,17 +229,17 @@ func CreateBlog(w http.ResponseWriter, r *http.Request) {
blog := new(Blog) blog := new(Blog)
if err := jsonapi.UnmarshalPayload(r.Body, blog); err != nil { if err := jsonapi.UnmarshalPayload(r.Body, blog); err != nil {
http.Error(w, err.Error(), 500) http.Error(w, err.Error(), http.StatusInternalServerError)
return return
} }
// ...save your blog... // ...save your blog...
w.WriteHeader(201) w.WriteHeader(http.StatusCreated)
w.Header().Set("Content-Type", "application/vnd.api+json") w.Header().Set("Content-Type", jsonapi.MediaType)
if err := jsonapi.MarshalOnePayload(w, blog); err != nil { if err := jsonapi.MarshalOnePayload(w, blog); err != nil {
http.Error(w, err.Error(), 500) http.Error(w, err.Error(), http.StatusInternalServerError)
} }
} }
``` ```
@ -292,10 +292,10 @@ func ListBlogs(w http.ResponseWriter, r *http.Request) {
// but, for now // but, for now
blogs := testBlogsForList() blogs := testBlogsForList()
w.WriteHeader(200) w.WriteHeader(http.StatusOK)
w.Header().Set("Content-Type", "application/vnd.api+json") w.Header().Set("Content-Type", jsonapi.MediaType)
if err := jsonapi.MarshalManyPayload(w, blogs); err != nil { if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
http.Error(w, err.Error(), 500) http.Error(w, err.Error(), http.StatusInternalServerError)
} }
} }
``` ```
@ -355,7 +355,7 @@ jsonapi.MarshalOnePayloadEmbedded(out, testModel())
h := new(BlogsHandler) h := new(BlogsHandler)
w := httptest.NewRecorder() w := httptest.NewRecorder()
r, _ := http.NewRequest("POST", "/blogs", out) r, _ := http.NewRequest(http.MethodPost, "/blogs", out)
h.CreateBlog(w, r) h.CreateBlog(w, r)

2
request.go
View File

@ -54,7 +54,7 @@ var (
// // ...do stuff with your blog... // // ...do stuff with your blog...
// //
// w.WriteHeader(201) // w.WriteHeader(201)
// w.Header().Set("Content-Type", "application/vnd.api+json") // w.Header().Set("Content-Type", jsonapi.MediaType)
// //
// if err := jsonapi.MarshalOnePayload(w, blog); err != nil { // if err := jsonapi.MarshalOnePayload(w, blog); err != nil {
// http.Error(w, err.Error(), 500) // http.Error(w, err.Error(), 500)

6
response.go
View File

@ -97,10 +97,10 @@ func MarshalOne(model interface{}) (*OnePayload, error) {
// //
// blogs := testBlogsForList() // blogs := testBlogsForList()
// //
// w.WriteHeader(200) // w.WriteHeader(http.StatusOK)
// w.Header().Set("Content-Type", "application/vnd.api+json") // w.Header().Set("Content-Type", jsonapi.MediaType)
// if err := jsonapi.MarshalManyPayload(w, blogs); err != nil { // if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
// http.Error(w, err.Error(), 500) // http.Error(w, err.Error(), http.StatusInternalServerError)
// } // }
// } // }
// //