{"id":13768441,"url":"https://github.com/yayoc/swagger-to-flowtype","last_synced_at":"2025-04-09T20:09:44.090Z","repository":{"id":22014146,"uuid":"94670341","full_name":"yayoc/swagger-to-flowtype","owner":"yayoc","description":"Generate Flow types from swagger file","archived":false,"fork":false,"pushed_at":"2022-12-06T19:50:35.000Z","size":639,"stargazers_count":91,"open_issues_count":16,"forks_count":30,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T20:09:39.826Z","etag":null,"topics":["flowtype","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yayoc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-18T06:49:59.000Z","updated_at":"2022-11-12T22:29:18.000Z","dependencies_parsed_at":"2023-01-13T21:48:06.267Z","dependency_job_id":null,"html_url":"https://github.com/yayoc/swagger-to-flowtype","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yayoc%2Fswagger-to-flowtype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yayoc%2Fswagger-to-flowtype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yayoc%2Fswagger-to-flowtype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yayoc%2Fswagger-to-flowtype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yayoc","download_url":"https://codeload.github.com/yayoc/swagger-to-flowtype/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103871,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flowtype","swagger"],"created_at":"2024-08-03T16:01:21.446Z","updated_at":"2025-04-09T20:09:44.047Z","avatar_url":"https://github.com/yayoc.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":[],"readme":"# swagger-to-flowtype\n\n`swagger-to-flowtype` is a tool for generating type definitions of [Flow](https://flow.org/) from swagger file.\n\n## Getting started\n\n#### Install package\n\n`npm i -g swagger-to-flowtype`\n\n#### Generating flow type definitions\n\n`$swagger-to-flowtype \u003cYOUR SWAGGER FILE OR URL\u003e`\n\nThis command generates a file named **flowtype.js** includes type definitions as default.  \n\n##### Options\n\n*`Specify an output path`*\n\nYou can also specify an output path with `-d option`.\n\n`$swagger-to-flowtype \u003cYOUR SWAGGER FILE PATH OR URL\u003e -d \u003cOUTPUT FILE PATH\u003e` \n\n*`Supporting Maybe type`*\n\nIf you pass a `--check-required` option, `swagger-to-flowtype` will check `required field` on your swagger file, then output flow definitions with Maybe type.\n\n```json\n\"NewPet\": {\n  \"type\": \"object\",\n  \"required\": [\n    \"name\"\n  ],\n  \"properties\": {\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"tag\": {\n      \"type\": \"string\"\n    }\n  }\n}\n```\n\nwill be\n\n```js\nexport type NewPet = {\n  name: string,\n  tag?: string\n}\n```\n\n*`Transform property key to lower camel case`*\n\n`--lower-camel-case` option transforms each property keys to lower camel case.\n\n```json\n\"Cat\": {\n  \"type\": \"object\",\n  \"properties\": {\n    \"long_long_key\": {\n      \"type\": \"string\"\n    }\n  }\n}\n```\n\nwill be\n\n```js\nexport type Cat = { longLongKey?: string };\n```\n\n## Example\n\nswagger file like following \n\n```yaml\n...\n\ndefinitions:\n  Order:\n    type: \"object\"\n    properties:\n      id:\n        type: \"integer\"\n        format: \"int64\"\n      petId:\n        type: \"integer\"\n        format: \"int64\"\n      quantity:\n        type: \"integer\"\n        format: \"int32\"\n      shipDate:\n        type: \"string\"\n        format: \"date-time\"\n      status:\n        type: \"string\"\n        description: \"Order Status\"\n        enum:\n        - \"placed\"\n        - \"approved\"\n        - \"delivered\"\n      complete:\n        type: \"boolean\"\n        default: false\n    xml:\n      name: \"Order\"\n  Category:\n    type: \"object\"\n    properties:\n      id:\n        type: \"integer\"\n        format: \"int64\"\n      name:\n        type: \"string\"\n    xml:\n      name: \"Category\"\n...\n\n```\n\nOutput will be like below\n\n```js\n// @flow\nexport type Order = {\n  id: number,\n  petId: number,\n  quantity: number,\n  shipDate: string,\n  status: 'placed' | 'approved' | 'delivered',\n  complete: boolean\n};\nexport type Category = { id: number, name: string };\n\n```\n\n## Requirements\n\n**Node 4+ is required**\n\n## Tests\n\n`npm test`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyayoc%2Fswagger-to-flowtype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyayoc%2Fswagger-to-flowtype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyayoc%2Fswagger-to-flowtype/lists"}