-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmock-api.yaml
More file actions
126 lines (126 loc) · 3.06 KB
/
mock-api.yaml
File metadata and controls
126 lines (126 loc) · 3.06 KB
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
122
123
124
125
126
openapi: 3.0.0
info:
title: Mock API
version: 1.0.0
paths:
/v1/user:
get:
responses:
200:
description: List of users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
example:
- id: 123
username: "John Doe"
address_id: 456
- id: 124
username: "Jane Smith"
address_id: 457
/v1/user/{id}:
get:
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
200:
description: Single user
content:
application/json:
schema:
$ref: '#/components/schemas/User'
examples:
user123:
value:
id: 123
username: "John Doe"
address_id: 456
user124:
value:
id: 124
username: "Jane Smith"
address_id: 457
/v1/address:
get:
responses:
200:
description: List of addresses
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Address'
example:
- id: 456
street: "123 Main St"
city: "New York"
country: "USA"
- id: 457
street: "456 Oak Ave"
city: "San Francisco"
country: "USA"
/v1/address/{id}:
get:
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
200:
description: Single address
content:
application/json:
schema:
$ref: '#/components/schemas/Address'
examples:
address456:
value:
id: 456
street: "123 Main St"
city: "New York"
country: "USA"
address457:
value:
id: 457
street: "456 Oak Ave"
city: "San Francisco"
country: "USA"
components:
schemas:
User:
type: object
properties:
id:
type: integer
example: 123
username:
type: string
example: "John Doe"
address_id:
type: integer
example: 456
Address:
type: object
properties:
id:
type: integer
example: 456
street:
type: string
example: "123 Main St"
city:
type: string
example: "New York"
country:
type: string
example: "USA"