Add control of response content-type (#15)

Author: vearutop

openapi3/entities.go

@@ -58,6 +58,7 @@ type OperationContext struct {
 
 	Output            interface{}
 	HTTPStatus        int
+	RespContentType   string
 	RespHeaderMapping map[string]string
 }
 
@@ -345,7 +346,9 @@ func (r *Reflector) SetupResponse(oc OperationContext) error {
 	resp := Response{}
 
 	if oc.Output != nil {
-		err := r.parseJSONResponse(&resp, oc.Output)
+		oc.RespContentType = strings.Split(oc.RespContentType, ";")[0]
+
+		err := r.parseJSONResponse(&resp, oc.Output, oc.RespContentType)
 		if err != nil {
 			return err
 		}
@@ -354,6 +357,10 @@ func (r *Reflector) SetupResponse(oc OperationContext) error {
 		if err != nil {
 			return err
 		}
+
+		if oc.RespContentType != "" {
+			r.ensureResponseContentType(&resp, oc.RespContentType)
+		}
 	}
 
 	if resp.Description == "" {
@@ -367,7 +374,19 @@ func (r *Reflector) SetupResponse(oc OperationContext) error {
 	return nil
 }
 
-func (r *Reflector) parseJSONResponse(resp *Response, output interface{}) error {
+func (r *Reflector) ensureResponseContentType(resp *Response, contentType string) {
+	if _, ok := resp.Content[contentType]; !ok {
+		if resp.Content == nil {
+			resp.Content = map[string]MediaType{}
+		}
+
+		resp.Content[contentType] = MediaType{
+			Schema: &SchemaOrRef{Schema: &Schema{}},
+		}
+	}
+}
+
+func (r *Reflector) parseJSONResponse(resp *Response, output interface{}, contentType string) error {
 	// Check if output structure exposes meaningful schema.
 	if hasJSONBody, err := r.hasJSONBody(output); err == nil && !hasJSONBody {
 		return nil
@@ -393,7 +412,11 @@ func (r *Reflector) parseJSONResponse(resp *Response, output interface{}) error
 		resp.Content = map[string]MediaType{}
 	}
 
-	resp.Content[mimeJSON] = MediaType{
+	if contentType == "" {
+		contentType = mimeJSON
+	}
+
+	resp.Content[contentType] = MediaType{
 		Schema:        &oaiSchema,
 		Example:       nil,
 		Examples:      nil,

openapi3/reflect.go

@@ -339,8 +339,9 @@ func TestReflector_SetupResponse(t *testing.T) {
 	s.Info.Version = apiVersion
 
 	require.NoError(t, reflector.SetupResponse(openapi3.OperationContext{
-		Operation:  &op,
-		HTTPStatus: http.StatusNoContent,
+		Operation:       &op,
+		RespContentType: "text/csv; charset=utf-8",
+		HTTPStatus:      http.StatusNoContent,
 		Output: new(struct {
 			Val1 int
 			Val2 string
@@ -366,7 +367,8 @@ func TestReflector_SetupResponse(t *testing.T) {
 		  "headers":{
 		   "X-Value-1":{"style":"simple","schema":{"type":"integer"}},
 		   "X-Value-2":{"style":"simple","schema":{"type":"string"}}
-		  }
+		  },
+		  "content":{"text/csv":{"schema":{}}}
 		 }
 		}
 	   }