libopenapi/renderer/mock_generator_examples_test.go at main · pb33f/libopenapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT

package renderer

import (
	"fmt"
	"os"

	"github.com/pb33f/libopenapi"
)

func ExampleMockGenerator_generateBurgerMock_yaml() {
	// create a new YAML mock generator
	mg := NewMockGenerator(YAML)

	burgerShop, _ := os.ReadFile("../test_specs/burgershop.openapi.yaml")

	// create a new document from specification and build a v3 model.
	document, _ := libopenapi.NewDocument(burgerShop)
	v3Model, _ := document.BuildV3Model()

	// create a mock of the Burger model
	burgerModel := v3Model.Model.Components.Schemas.GetOrZero("Burger")
	burger := burgerModel.Schema()
	mock, err := mg.GenerateMock(burger, "")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(mock))
	// Output: name: Big Mac
	// numPatties: 2
}

func ExampleMockGenerator_generateFriesMock_json() {
	// create a new YAML mock generator
	mg := NewMockGenerator(JSON)

	burgerShop, _ := os.ReadFile("../test_specs/burgershop.openapi.yaml")

	// create a new document from specification and build a v3 model.
	document, _ := libopenapi.NewDocument(burgerShop)
	v3Model, _ := document.BuildV3Model()

	// create a mock of the Fries model
	friesModel := v3Model.Model.Components.Schemas.GetOrZero("Fries")
	fries := friesModel.Schema()
	mock, err := mg.GenerateMock(fries, "")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(mock))
	// Output: {"favoriteDrink":{"drinkType":"coke","size":"M"},"potatoShape":"Crispy Shoestring"}
}

func ExampleMockGenerator_generateRequestMock_json() {
	// create a new YAML mock generator
	mg := NewMockGenerator(JSON)

	burgerShop, _ := os.ReadFile("../test_specs/burgershop.openapi.yaml")

	// create a new document from specification and build a v3 model.
	document, _ := libopenapi.NewDocument(burgerShop)
	v3Model, _ := document.BuildV3Model()

	// create a mock of the burger request model, extracted from the operation directly.
	burgerRequestModel := v3Model.Model.Paths.PathItems.GetOrZero("/burgers").
		Post.RequestBody.Content.GetOrZero("application/json")

	// use the 'cakeBurger' example to generate a mock
	mock, err := mg.GenerateMock(burgerRequestModel, "cakeBurger")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(mock))
	// Output: {"name":"Chocolate Cake Burger","numPatties":5}
}

func ExampleMockGenerator_generateResponseMock_json() {
	mg := NewMockGenerator(JSON)
	// create a new YAML mock generator

	burgerShop, _ := os.ReadFile("../test_specs/burgershop.openapi.yaml")

	// create a new document from specification and build a v3 model.
	document, _ := libopenapi.NewDocument(burgerShop)
	v3Model, _ := document.BuildV3Model()

	// create a mock of the burger response model, extracted from the operation directly.
	burgerResponseModel := v3Model.Model.Paths.PathItems.GetOrZero("/burgers").
		Post.Responses.Codes.GetOrZero("200").Content.GetOrZero("application/json")

	// use the 'filetOFish' example to generate a mock
	mock, err := mg.GenerateMock(burgerResponseModel, "filetOFish")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(mock))
	// Output: {"name":"Filet-O-Fish","numPatties":1}
}

func ExampleMockGenerator_generatePolymorphicMock_json() {
	mg := NewMockGenerator(JSON)
	// create a new YAML mock generator

	burgerShop, _ := os.ReadFile("../test_specs/burgershop.openapi.yaml")

	// create a new document from specification and build a v3 model.
	document, _ := libopenapi.NewDocument(burgerShop)
	v3Model, _ := document.BuildV3Model()

	// create a mock of the SomePayload component, which uses polymorphism (incorrectly)
	payloadModel := v3Model.Model.Components.Schemas.GetOrZero("SomePayload")
	payload := payloadModel.Schema()
	mock, err := mg.GenerateMock(payload, "")
	if err != nil {
		panic(err)
	}
	fmt.Println(string(mock))
	// Output: {"drinkType":"coke","size":"M"}
}