swagger-to-mock
v0.1.12
Published
mock data generator from Swagger (OpenAPI 3)
Downloads
115,950
Readme
swagger-to-mock
Mock data generator CLI for Swagger3 (OpenAPI 3)
Install
npm i -g swagger-to-mock
Generate mock data
swagger-to-mock <YOUR SWAGGER FILE>
will generate JSON file per each API response.
JSON data values should be example values on your swagger if you specified examples.
Otherwise, swagger-to-mock
follows data type rules and generate arbitrary values.
If there is no rule like format
, values should be below.
string: ""
number: 0
integer: 0
boolean: true
array: []
object: {}
Example
If we pass an example YAML file
responses:
'200':
description: pet response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
swagger-to-mock
will generate file named pets_get_200.json
and the body should be below
[
{
"name": "",
"tag": "",
"id": 0
}
]
File Name
Naming JSON file will follow the format below.
${API_PATH}_${HTTP_METHOD}_${RESPONSE_STATUS}.json
Data Type Support [In Progress]
swagger-to-mock
will follow rules based on OpenAPI 3 specification for each data type, If the example value is not specified.
Mixed Types
If you specify oneOf
or anyOf
, The value should be at the top type.
Numbers
- format
- Minimum and Maximum
- Multiples
String
- format
- pattern
Boolean
value should be true
or false
.
Null
Arrays
- Mixed-Type Arrays
- Array Length
Objects
- Free-Form Object