add DefaultReturns to RouteBuilder emicklei/go-restful-openapi#10

MustWin · Mar 27, 2017 · 1d2cd46 · 1d2cd46
1 parent cf834cf
commit 1d2cd46
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 7 deletions.
diff --git a/route_builder.go b/route_builder.go
@@ -156,9 +156,10 @@ func (b *RouteBuilder) ReturnsError(code int, message string, model interface{})
 // The model parameter is optional ; either pass a struct instance or use nil if not applicable.
 func (b *RouteBuilder) Returns(code int, message string, model interface{}) *RouteBuilder {
 	err := ResponseError{
-		Code:    code,
-		Message: message,
-		Model:   model,
+		Code:      code,
+		Message:   message,
+		Model:     model,
+		IsDefault: false,
 	}
 	// lazy init because there is no NewRouteBuilder (yet)
 	if b.errorMap == nil {
@@ -168,6 +169,22 @@ func (b *RouteBuilder) Returns(code int, message string, model interface{}) *Rou
 	return b
 }
 
+// DefaultReturns is a special Returns call that sets the default of the response ; the code is zero.
+func (b *RouteBuilder) DefaultReturns(message string, model interface{}) *RouteBuilder {
+	b.Returns(0, message, model)
+	// Modify the ResponseError just added/updated
+	re := b.errorMap[0]
+	// errorMap is initialized
+	b.errorMap[0] = ResponseError{
+		Code:      re.Code,
+		Message:   re.Message,
+		Model:     re.Model,
+		IsDefault: true,
+	}
+	return b
+}
+
+// Metadata adds or updates a key=value pair to the metadata map.
 func (b *RouteBuilder) Metadata(key string, value interface{}) *RouteBuilder {
 	if b.metadata == nil {
 		b.metadata = map[string]interface{}{}
@@ -176,10 +193,12 @@ func (b *RouteBuilder) Metadata(key string, value interface{}) *RouteBuilder {
 	return b
 }
 
+// ResponseError represents a response; not necessarily an error.
 type ResponseError struct {
-	Code    int
-	Message string
-	Model   interface{}
+	Code      int
+	Message   string
+	Model     interface{}
+	IsDefault bool
 }
 
 func (b *RouteBuilder) servicePath(path string) *RouteBuilder {

diff --git a/route_builder_test.go b/route_builder_test.go
@@ -2,6 +2,7 @@ package restful
 
 import (
 	"testing"
+	"time"
 )
 
 func TestRouteBuilder_PathParameter(t *testing.T) {
@@ -41,7 +42,7 @@ func TestRouteBuilder(t *testing.T) {
 	json := "application/json"
 	b := new(RouteBuilder)
 	b.To(dummy)
-	b.Path("/routes").Method("HEAD").Consumes(json).Produces(json).Metadata("test", "test-value")
+	b.Path("/routes").Method("HEAD").Consumes(json).Produces(json).Metadata("test", "test-value").DefaultReturns("default", time.Now())
 	r := b.Build()
 	if r.Path != "/routes" {
 		t.Error("path invalid")
@@ -58,6 +59,9 @@ func TestRouteBuilder(t *testing.T) {
 	if r.Metadata["test"] != "test-value" {
 		t.Errorf("Metadata not set")
 	}
+	if _, ok := r.ResponseErrors[0]; !ok {
+		t.Fatal("expected default response")
+	}
 }
 
 func TestAnonymousFuncNaming(t *testing.T) {