move operation's RequestBody into a named element of Components.Schemas

fizz_test.go

@@ -228,6 +228,11 @@ type testInputModel struct {
 	QueryParam string `query:"q"`
 }
 
+type testInputModel2 struct {
+	C       string `path:"c"`
+	Message string `json:"message" description:"A short message"`
+}
+
 // TestSpecHandler tests that the OpenAPI handler
 // return the spec properly marshaled in JSON.
 func TestSpecHandler(t *testing.T) {
@@ -272,6 +277,18 @@ func TestSpecHandler(t *testing.T) {
 		Description: `This is a test server.`,
 		Version:     "1.0.0",
 	}
+
+	fizz.POST("/test/:c",
+		[]OperationOption{
+			ID("PostTest"),
+			StatusDescription("201"),
+			StatusDescription("Created"),
+		},
+		tonic.Handler(func(c *gin.Context, in *testInputModel2) error {
+			return nil
+		}, 201),
+	)
+
 	servers := []*openapi.Server{
 		&openapi.Server{
 			URL:         "https://foo.bar/{basePath}",

openapi/generator.go

@@ -15,11 +15,12 @@ import (
 )
 
 const (
-	version        = "3.0.1"
-	anyMediaType   = "*/*"
-	formatTag      = "format"
-	deprecatedTag  = "deprecated"
-	descriptionTag = "description"
+	version              = "3.0.1"
+	anyMediaType         = "*/*"
+	formatTag            = "format"
+	deprecatedTag        = "deprecated"
+	descriptionTag       = "description"
+	componentsSchemaPath = "#/components/schemas/"
 )
 
 var (
@@ -408,6 +409,26 @@ func (g *Generator) setOperationParams(op *Operation, t, parent reflect.Type, al
 	if err := g.buildParamsRecursive(op, t, parent, allowBody); err != nil {
 		return err
 	}
+	// Input fields that are neither path- nor query-bound
+	// have been extracted into the operation's RequestBody
+	// If the RequestBody is not nil, give it a name and
+	// move it to the openapi spec's components/schemas section
+	// Replace the RequestBody's schema with a reference
+	// to the named schema in components/schemas
+	if op.RequestBody != nil {
+		mt := tonic.MediaType()
+		if mt == "" {
+			mt = anyMediaType
+		}
+		sch := op.RequestBody.Content[mt].Schema
+		if sch != nil {
+			name := strings.Title(op.ID) + "Input"
+			g.api.Components.Schemas[name] = sch
+			op.RequestBody.Content[mt].Schema = &SchemaOrRef{Reference: &Reference{
+				Ref: componentsSchemaPath + name,
+			}}
+		}
+	}
 	// Extract all the path parameter names.
 	matches := paramsInPathRe.FindAllStringSubmatch(path, -1)
 	var pathParams []string
@@ -901,7 +922,7 @@ func (g *Generator) newSchemaFromStruct(t reflect.Type) *SchemaOrRef {
 	// because there is no guarantee the generation is complete yet.
 	if _, ok := g.schemaTypes[t]; ok {
 		return &SchemaOrRef{Reference: &Reference{
-			Ref: "#/components/schemas/" + name,
+			Ref: componentsSchemaPath + name,
 		}}
 	}
 	schema := &Schema{
@@ -925,7 +946,7 @@ func (g *Generator) newSchemaFromStruct(t reflect.Type) *SchemaOrRef {
 		g.api.Components.Schemas[name] = sor
 
 		return &SchemaOrRef{Reference: &Reference{
-			Ref: "#/components/schemas/" + name,
+			Ref: componentsSchemaPath + name,
 		}}
 	}
 	// Return an inlined schema for types with no name.

testdata/schemas/path-item.json

@@ -101,21 +101,7 @@
             "content": {
                 "application/json": {
                     "schema": {
-                        "type": "object",
-                        "properties": {
-                            "G": {
-                                "type": "string",
-                                "format": "byte"
-                            },
-                            "f": {
-                                "type": "string",
-                                "description": "This is F",
-                                "nullable": true
-                            }
-                        },
-                        "required": [
-                            "G"
-                        ]
+                        "$ref": "#/components/schemas/CreateTestInput"
                     }
                 }
             }

testdata/spec.json

@@ -96,7 +96,48 @@
                     }
                 }
             }
+        },
+        "/test/{c}": {
+            "post": {
+                "operationId": "PostTest",
+                "parameters": [
+                    {
+                        "name": "c",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/PostTestInput"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "201": {
+                        "description": "Created"
+                    }
+                }
+            }
         }
     },
-    "components": {}
+    "components": {
+        "schemas": {
+            "PostTestInput": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "A short message"
+                    }
+                }
+            }
+        }
+    }
 }

testdata/spec.yaml

@@ -63,4 +63,28 @@ paths:
       responses:
         '200':
           description: OK
-components: {}
+  /test/{c}:
+    post:
+      operationId: PostTest
+      parameters:
+      - name: c
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PostTestInput"
+      responses:
+        "201":
+          description: Created
+components:
+  schemas:
+    PostTestInput:
+      type: object
+      properties:
+        message:
+          type: string
+          description: "A short message"