Support response headers, dependency bump

Author: danielgtaylor

CHANGELOG.md

@@ -5,7 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- Add unreleased items here.
+- Return header examples when possible.
+- Update dependency versions.
 
 ## [1.3.0] - 2019-03-18
 - Add `--add-server` to add a custom server when using `--validate-server`.

apisprout.go

@@ -163,8 +163,10 @@ func getTypedExample(mt *openapi3.MediaType) (interface{}, error) {
 }
 
 // getExample tries to return an example for a given operation.
-func getExample(negotiator *ContentNegotiator, prefer string, op *openapi3.Operation) (int, string, interface{}, error) {
+func getExample(negotiator *ContentNegotiator, prefer string, op *openapi3.Operation) (int, string, map[string]*openapi3.HeaderRef, interface{}, error) {
 	var responses []string
+	var blankHeaders = make(map[string]*openapi3.HeaderRef)
+
 	if prefer == "" {
 		// First, make a list of responses ordered by successful (200-299 status code)
 		// before other types.
@@ -180,7 +182,7 @@ func getExample(negotiator *ContentNegotiator, prefer string, op *openapi3.Opera
 		responses = append(success, other...)
 	} else {
 		if op.Responses[prefer] == nil {
-			return 0, "", nil, ErrNoExample
+			return 0, "", blankHeaders, nil, ErrNoExample
 		}
 		responses = []string{prefer}
 	}
@@ -196,7 +198,7 @@ func getExample(negotiator *ContentNegotiator, prefer string, op *openapi3.Opera
 
 		if response.Value.Content == nil {
 			// This is a valid response but has no body defined.
-			return status, "", "", nil
+			return status, "", blankHeaders, "", nil
 		}
 
 		for mt, content := range response.Value.Content {
@@ -207,14 +209,14 @@ func getExample(negotiator *ContentNegotiator, prefer string, op *openapi3.Opera
 
 			example, err := getTypedExample(content)
 			if err == nil {
-				return status, mt, example, nil
+				return status, mt, response.Value.Headers, example, nil
 			}
 
 			fmt.Printf("Error getting example: %v\n", err)
 		}
 	}
 
-	return 0, "", nil, ErrNoExample
+	return 0, "", blankHeaders, nil, ErrNoExample
 }
 
 // addLocalServers will ensure that requests to localhost are always allowed
@@ -540,7 +542,7 @@ func server(cmd *cobra.Command, args []string) {
 			prefer = ""
 		}
 
-		status, mediatype, example, err := getExample(negotiator, prefer, route.Operation)
+		status, mediatype, headers, example, err := getExample(negotiator, prefer, route.Operation)
 		if err != nil {
 			log.Printf("%s => Missing example", info)
 			w.WriteHeader(http.StatusTeapot)
@@ -579,8 +581,26 @@ func server(cmd *cobra.Command, args []string) {
 			}
 		}
 
+		for name, header := range headers {
+			if header.Value != nil {
+				example := name
+
+				if header.Value.Schema != nil && header.Value.Schema.Value != nil {
+					if v, err := OpenAPIExample(ModeResponse, header.Value.Schema.Value); err == nil {
+						if vs, ok := v.(string); ok {
+							example = vs
+						} else {
+							fmt.Printf("Could not convert example value '%v' to string", v)
+						}
+					}
+				}
+
+				w.Header().Set(name, example)
+			}
+		}
+
 		if mediatype != "" {
-			w.Header().Add("Content-Type", mediatype)
+			w.Header().Set("Content-Type", mediatype)
 		}
 
 		w.WriteHeader(status)

go.mod

@@ -3,17 +3,20 @@ module github.com/danielgtaylor/apisprout
 go 1.12
 
 require (
-	github.com/BurntSushi/toml v0.3.1 // indirect
+	github.com/davecgh/go-spew v1.1.1
 	github.com/fsnotify/fsnotify v1.4.7
-	github.com/getkin/kin-openapi v0.1.1-0.20190210195911-82a13f94c08e
+	github.com/getkin/kin-openapi v0.2.0
 	github.com/gobwas/glob v0.2.3
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/magiconair/properties v1.8.1 // indirect
+	github.com/pelletier/go-toml v1.4.0 // indirect
 	github.com/pkg/errors v0.8.1
-	github.com/spf13/afero v1.2.1 // indirect
-	github.com/spf13/cobra v0.0.3
+	github.com/spf13/afero v1.2.2 // indirect
+	github.com/spf13/cobra v0.0.4
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.3
-	github.com/spf13/viper v1.3.1
+	github.com/spf13/viper v1.4.0
 	github.com/stretchr/testify v1.3.0
-	golang.org/x/sys v0.0.0-20190226215855-775f8194d0f9 // indirect
+	golang.org/x/sys v0.0.0-20190530182044-ad28b68e88f1 // indirect
+	golang.org/x/text v0.3.2 // indirect
 	gopkg.in/yaml.v2 v2.2.2
 )