Add schemes to API design

cinderalla · Nov 15, 2015 · 5c02ae4 · 5c02ae4
1 parent 2688d50
commit 5c02ae4
Show file tree

Hide file tree

Showing 15 changed files with 632 additions and 848 deletions.
diff --git a/design/definitions.go b/design/definitions.go
@@ -35,6 +35,8 @@ type (
 		Description string // API description
 		// API hostname
 		Host string
+		// API URL schemes
+		Schemes []string
 		// Common base path to all API actions
 		BasePath string
 		// Common path parameters to all API actions

diff --git a/design/dsl/api.go b/design/dsl/api.go
@@ -28,6 +28,7 @@ import (
 //			URL("doc URL")
 //		})
 //		Host("goa.design")                      // API hostname
+//		Schemes("http")
 // 		BasePath("/base/:param")                // Common base path to all API actions
 // 		BaseParams(func() {                     // Common parameters to all API actions
 // 			Param("param")
@@ -150,6 +151,19 @@ func Host(host string) {
 	}
 }
 
+// Schemes sets the API URL schemes.
+func Schemes(vals ...string) {
+	if a, ok := apiDefinition(true); ok {
+		for _, v := range vals {
+			if v != "http" && v != "https" && v != "ws" && v != "wss" {
+				ReportError(`invalid scheme "%s", must be one of "http", "https", "ws" or "wss"`, v)
+			} else {
+				a.Schemes = append(a.Schemes, v)
+			}
+		}
+	}
+}
+
 // Contact sets the API contact information.
 func Contact(dsl func()) {
 	if a, ok := apiDefinition(true); ok {