Update documentation for responding with proper JSON API headers (goo…

…gle#84) * Update documentation for responding with proper JSONAPI headers * Fixed examples and commented code for sending proper response headers
adamlounds · Apr 5, 2017 · af3dab1 · af3dab1
1 parent bce7629
commit af3dab1
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -232,8 +232,8 @@ func CreateBlog(w http.ResponseWriter, r *http.Request) {
 
 	// ...save your blog...
 
-	w.WriteHeader(http.StatusCreated)
 	w.Header().Set("Content-Type", jsonapi.MediaType)
+	w.WriteHeader(http.StatusCreated)
 
 	if err := jsonapi.MarshalOnePayload(w, blog); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
@@ -288,8 +288,9 @@ func ListBlogs(w http.ResponseWriter, r *http.Request) {
   // but, for now
 	blogs := testBlogsForList()
 
-	w.WriteHeader(http.StatusOK)
 	w.Header().Set("Content-Type", jsonapi.MediaType)
+	w.WriteHeader(http.StatusOK)
+
 	if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}
@@ -325,8 +326,9 @@ func CreateBlogs(w http.ResponseWriter, r *http.Request) {
 		// ...save each of your blogs
 	}
 
-	w.WriteHeader(http.StatusCreated)
 	w.Header().Set("Content-Type", jsonapi.MediaType)
+	w.WriteHeader(http.StatusCreated)
+
 	if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}

diff --git a/examples/handler.go b/examples/handler.go
@@ -105,8 +105,9 @@ func (h *ExampleHandler) listBlogs(w http.ResponseWriter, r *http.Request) {
 	// but, for now
 	blogs := fixtureBlogsList()
 
-	w.WriteHeader(http.StatusOK)
 	w.Header().Set("Content-Type", jsonapi.MediaType)
+	w.WriteHeader(http.StatusOK)
+
 	if err := jsonapiRuntime.MarshalManyPayload(w, blogs); err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 	}

diff --git a/request.go b/request.go
@@ -55,8 +55,8 @@ var (
 //
 //   	// ...do stuff with your blog...
 //
-//   	w.WriteHeader(201)
 //   	w.Header().Set("Content-Type", jsonapi.MediaType)
+//   	w.WriteHeader(201)
 //
 //   	if err := jsonapi.MarshalOnePayload(w, blog); err != nil {
 //   		http.Error(w, err.Error(), 500)

diff --git a/response.go b/response.go
@@ -122,8 +122,9 @@ func MarshalManyPayloadWithoutIncluded(w io.Writer, models interface{}) error {
 //
 //		 blogs := testBlogsForList()
 //
-//		 w.WriteHeader(http.StatusOK)
 //		 w.Header().Set("Content-Type", jsonapi.MediaType)
+//		 w.WriteHeader(http.StatusOK)
+//
 //		 if err := jsonapi.MarshalManyPayload(w, blogs); err != nil {
 //			 http.Error(w, err.Error(), http.StatusInternalServerError)
 //		 }