Python utility created to convert JSON to Swagger definitions structure, based on entities concept.
Project description
"Json to Swagger" conversor
Python utility created to convert JSON to Swagger definitions structure, based on entities concept.
Dependencies
- Python 3.6+
- Libraries:
- swagger-parser
- pyyaml
- pattern
Note: Before run, execute:
$ pip install -r requirements.txt
Usage
Running:
$ python main.py <json-file-path> <RootEntityName> [swagger-file-path] [-v]
json-file-path
- path of json file to convertRootEntityName
- name of root swagger definitions entityswagger-file-path
- path of swagger file. If the file has content, it will be merged with json converted content-v
- verbose mode
example.json
{
"id": "ffe74d36-4f76-4ca6-9dd1-8d5c9b16b056",
"name": "JSON example",
"description": "Just a simple JSON file to convert into swagger definition",
"someObject": {
"someInteger": 0,
"someNumber": 0.1,
"someBoolean": true,
"someNull": null,
"someString": "Example string content"
},
"items": [
{
"name": "Item",
"subItem": {
"subItemsOfSubItem": [
{
"foo": "bar"
}
]
}
}
]
}
example.swagger.yaml
definitions:
Root:
type: object
title: Root
description: Root Entity
properties:
id:
type: string
example: ffe74d36-4f76-4ca6-9dd1-8d5c9b16b056
name:
type: string
example: JSON example
description:
type: string
example: Just a simple JSON file to convert into swagger definition
someObject:
$ref: '#/definitions/SomeObject'
items:
type: array
items:
$ref: '#/definitions/Item'
SomeObject:
type: object
title: Some Object
description: Some Object Entity
properties:
someInteger:
type: integer
example: 0
someNumber:
type: number
example: 0.1
someBoolean:
type: boolean
example: true
someNull:
type: string
example: null
someString:
type: string
example: Example string content
Item:
type: object
title: Item
description: Item Entity
properties:
name:
type: string
example: Item
subItem:
$ref: '#/definitions/SubItem'
SubItem:
type: object
title: Sub Item
description: Sub Item Entity
properties:
subItemsOfSubItem:
type: array
items:
$ref: '#/definitions/SubItemsOfSubItem'
SubItemsOfSubItem:
type: object
title: Sub Items Of Sub Item
description: Sub Items Of Sub Item Entity
properties:
foo:
type: string
example: bar
Attention: Properties with same name will be merged
Example
In the JSON structure bellow, it has the "items" property in two objects:
{
"items": [
{
"name": "Item",
"subItem": {
"items": [
{
"foo": "bar"
}
]
}
}
]
}
The result will merge the two "items" properties into "Item" entity:
definitions:
RootEntity:
type: object
title: Root
description: Root Entity
properties:
items:
type: array
items:
$ref: '#/definitions/Item'
Item:
type: object
title: Item
description: Item Entity
properties:
name:
type: string
example: Item
subItem:
$ref: '#/definitions/SubItem'
foo:
type: string
example: bar
SubItem:
type: object
title: Sub Item
description: Sub Item Entity
properties:
items:
type: array
items:
$ref: '#/definitions/Item'
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
json-to-swagger-0.0.2.tar.gz
(3.8 kB
view hashes)
Built Distribution
Close
Hashes for json_to_swagger-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50b323dde1e488e3449887421ece0dfe2b5ac3b10d8208bc081524330f55ea38 |
|
MD5 | 03ad64adc9b261520e07d3d15755bb54 |
|
BLAKE2b-256 | ac512df915e3d4263b426570d214e7d8a8d869ecd2d27bb391438e1317f7de79 |