Merge branch 'master' into prefer-request

Author: danielgtaylor

README.md

@@ -15,6 +15,7 @@ A simple, quick, cross-platform API mock server that returns examples specified
 - Server validation (enabled with `--validate-server`)
   - Validates scheme, hostname/port, and base path
   - Supports `localhost` out of the box
+  - Use the `--add-server` flag, in conjunction with `--validate-server`, to dynamically include more servers in the validation logic
 - Request parameter & body validation (enabled with `--validate-request`)
 - Configuration via:
   - Files (`/etc/apisprout/config.json|yaml`)
@@ -30,6 +31,9 @@ apisprout my-api.yaml
 # Validate server name and use base path
 apisprout --validate-server my-api.yaml
 
+# Dynamically Include a new server / path in the validation
+apisprout --add-server http://localhost:8080/mock --validate-server my-api.yaml
+
 # Load from a URL
 apisprout https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/api-with-examples.yaml
 ```
@@ -60,6 +64,16 @@ Alternatively, you can use `go get`:
 go get github.com/danielgtaylor/apisprout
 ```
 
+## Extra Features
+
+### Remote Reload
+
+If your API spec is loaded from a remote URL, you can live-reload it by hitting the `/__reload` endpoint.
+
+### Health Check
+
+A simple endpoint which returns status code `200` is available at `/__health`. This endpoint successfully returns `200` even if `--validate-server` is turned on, and the endpoint is being accessed from a non-validated host.
+
 ## Contributing
 
 Contributions are very welcome. Please open a tracking issue or pull request and we can work to get things merged in.

apisprout.go

@@ -116,6 +116,9 @@ func main() {
 	addParameter(flags, "disable-cors", "", false, "Disable CORS headers")
 	addParameter(flags, "header", "H", "", "Add a custom header when fetching API")
 	addParameter(flags, "add-server", "", "", "Add a new valid server URL, use with --validate-server")
+	addParameter(flags, "https", "", false, "Use HTTPS instead of HTTP")
+	addParameter(flags, "public-key", "", "", "Public key for HTTPS, use with --https")
+	addParameter(flags, "private-key", "", "", "Private key for HTTPS, use with --https")
 
 	// Run the app!
 	root.Execute()
@@ -193,19 +196,25 @@ func getExample(negotiator *ContentNegotiator, prefer map[string]string, op *ope
 			other = append(other, s)
 		}
 		responses = append(success, other...)
-	} else {
-		if op.Responses[prefer["status"]] == nil {
-			return 0, "", blankHeaders, nil, ErrNoExample
-		}
+	} else if op.Responses[prefer["status"]] != nil {
 		responses = []string{prefer["status"]}
+	} else if op.Responses["default"] != nil {
+		responses = []string{"default"}
+	} else {
+		return 0, "", blankHeaders, nil, ErrNoExample
 	}
 
 	// Now try to find the first example we can and return it!
 	for _, s := range responses {
 		response := op.Responses[s]
 		status, err := strconv.Atoi(s)
 		if err != nil {
-			// Treat default and other named statuses as 200.
+			// If we are using the default with prefer, we can use its status
+			// code:
+			status, err = strconv.Atoi(prefer)
+		}
+		if err != nil {
+			// Otherwise, treat default and other named statuses as 200.
 			status = http.StatusOK
 		}
 
@@ -511,6 +520,12 @@ func server(cmd *cobra.Command, args []string) {
 		})
 	}
 
+	// Add a health check route which returns 200
+	http.HandleFunc("/__health", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+		log.Printf("Health check")
+	})
+
 	// Register our custom HTTP handler that will use the router to find
 	// the appropriate OpenAPI operation and try to return an example.
 	http.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
@@ -675,7 +690,11 @@ func server(cmd *cobra.Command, args []string) {
 		w.Write(encoded)
 	})
 
-	fmt.Printf("🌱 Sprouting %s on port %d", swagger.Info.Title, viper.GetInt("port"))
+	format := "🌱 Sprouting %s on port %d"
+	if viper.GetBool("https") {
+		format = "🌱 Securely sprouting %s on port %d"
+	}
+	fmt.Printf(format, swagger.Info.Title, viper.GetInt("port"))
 
 	if viper.GetBool("validate-server") && len(swagger.Servers) != 0 {
 		fmt.Printf(" with valid servers:\n")
@@ -686,5 +705,14 @@ func server(cmd *cobra.Command, args []string) {
 		fmt.Printf("\n")
 	}
 
-	http.ListenAndServe(fmt.Sprintf(":%d", viper.GetInt("port")), nil)
+	port := fmt.Sprintf(":%d", viper.GetInt("port"))
+	if viper.GetBool("https") {
+		err = http.ListenAndServeTLS(port, viper.GetString("public-key"),
+			viper.GetString("private-key"), nil)
+	} else {
+		err = http.ListenAndServe(port, nil)
+	}
+	if err != nil {
+		log.Fatal(err)
+	}
 }

example.go

@@ -100,6 +100,35 @@ func OpenAPIExample(mode Mode, schema *openapi3.Schema) (interface{}, error) {
 		return ex, nil
 	}
 
+	// Handle combining keywords
+	if len(schema.OneOf) > 0 {
+		return OpenAPIExample(mode, schema.OneOf[0].Value)
+	}
+	if len(schema.AnyOf) > 0 {
+		return OpenAPIExample(mode, schema.AnyOf[0].Value)
+	}
+	if len(schema.AllOf) > 0 {
+		example := map[string]interface{}{}
+
+		for _, allOf := range schema.AllOf {
+			candidate, err := OpenAPIExample(mode, allOf.Value)
+			if err != nil {
+				return nil, err
+			}
+
+			value, ok := candidate.(map[string]interface{})
+			if !ok {
+				return nil, ErrNoExample
+			}
+
+			for k, v := range value {
+				example[k] = v
+			}
+		}
+
+		return example, nil
+	}
+
 	switch {
 	case schema.Type == "boolean":
 		return true, nil

example_test.go

@@ -417,6 +417,67 @@ var schemaTests = []struct {
 		}`,
 		`{"normal": "string", "readOnly": "string"}`,
 	},
+	// ----- Combination keywords -----
+	{
+		"Combine with allOf",
+		`{
+			"allOf": [
+				{
+					"type": "object",
+					"properties": {
+						"foo": {"type": "string"}
+					}
+				},
+				{
+					"type": "object",
+					"properties": {
+						"bar": {"type": "boolean"}
+					}
+				}
+			]
+		}`,
+		`{"foo": "string", "bar": true}`,
+	},
+	{
+		"Combine with anyOf",
+		`{
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"foo": {"type": "string"}
+					}
+				},
+				{
+					"type": "object",
+					"properties": {
+						"bar": {"type": "boolean"}
+					}
+				}
+			]
+		}`,
+		`{"foo": "string"}`,
+	},
+	{
+		"Combine with oneOf",
+		`{
+			"oneOf": [
+				{
+					"type": "object",
+					"properties": {
+						"foo": {"type": "string"}
+					}
+				},
+				{
+					"type": "object",
+					"properties": {
+						"bar": {"type": "boolean"}
+					}
+				}
+			]
+		}`,
+		`{"foo": "string"}`,
+	},
 }
 
 func TestGenExample(t *testing.T) {

go.mod

@@ -3,7 +3,6 @@ module github.com/danielgtaylor/apisprout
 go 1.12
 
 require (
-	github.com/davecgh/go-spew v1.1.1
 	github.com/fsnotify/fsnotify v1.4.7
 	github.com/getkin/kin-openapi v0.2.0
 	github.com/gobwas/glob v0.2.3