docs: add an example for generate: models

Jamie Tanna · Jamie Tanna · commit a209e61bb5f3 · 2024-03-25T10:15:39.000Z
diff --git a/examples/only-models/api.yaml b/examples/only-models/api.yaml
@@ -0,0 +1,50 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Generate models
+paths:
+  /client:
+    get:
+      operationId: getClient
+      responses:
+        200:
+          content:
+            application/json:
+              schema:
+                # NOTE that Client is generated here, because it's within #/components/schemas
+                $ref: "#/components/schemas/Client"
+    put:
+      operationId: updateClient
+      responses:
+        400:
+          content:
+            application/json:
+              # NOTE that this anonymous object is /not/ generated because it's an anonymous, but would be generated if using `generate: client`
+              # See https://github.com/deepmap/oapi-codegen/issues/1512
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                required:
+                - code
+components:
+  schemas:
+    Client:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+    # NOTE that this is not generated by default because it's not referenced. If you want it, you need to use the following YAML configuration:
+    #
+    # output-options:
+    #   skip-prune: true
+    Unreferenced:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: integer
diff --git a/examples/only-models/cfg.yaml b/examples/only-models/cfg.yaml
@@ -0,0 +1,7 @@
+package: onlymodels
+output: only-models.gen.go
+generate:
+  models: true
+output-options:
+  # NOTE that this is only required for the `Unreferenced` type
+  skip-prune: true
diff --git a/examples/only-models/doc.go b/examples/only-models/doc.go
@@ -0,0 +1,3 @@
+package onlymodels
+
+//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen -config cfg.yaml api.yaml
diff --git a/examples/only-models/only-models.gen.go b/examples/only-models/only-models.gen.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package onlymodels`
	`2`	`+`
	`3`	`+//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen -config cfg.yaml api.yaml`