{"id":23464547,"url":"https://github.com/erichenry/swagger-data-gen","last_synced_at":"2025-04-14T10:07:45.433Z","repository":{"id":92137570,"uuid":"94325710","full_name":"EricHenry/swagger-data-gen","owner":"EricHenry","description":"Tool to generate random data from a Sagger/OpenAPI spec","archived":false,"fork":false,"pushed_at":"2019-05-20T13:52:57.000Z","size":94,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T10:07:21.524Z","etag":null,"topics":["cli","data","generator","mock-data","openapi","openapi-specification","random","swagger","tool"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/EricHenry.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-14T11:53:38.000Z","updated_at":"2025-01-14T04:55:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"01c12bee-d27a-4675-9495-8c109866369c","html_url":"https://github.com/EricHenry/swagger-data-gen","commit_stats":{"total_commits":27,"total_committers":4,"mean_commits":6.75,"dds":"0.37037037037037035","last_synced_commit":"17963a55fd7b4573c0e437b11346e515ca9a79c3"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EricHenry%2Fswagger-data-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EricHenry%2Fswagger-data-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EricHenry%2Fswagger-data-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EricHenry%2Fswagger-data-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EricHenry","download_url":"https://codeload.github.com/EricHenry/swagger-data-gen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248860268,"owners_count":21173342,"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":["cli","data","generator","mock-data","openapi","openapi-specification","random","swagger","tool"],"created_at":"2024-12-24T10:34:02.709Z","updated_at":"2025-04-14T10:07:45.395Z","avatar_url":"https://github.com/EricHenry.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"_This project is based on [booknds/swagger-data-generator](https://github.com/booknds/swagger-data-generator)_\n\n# swagger-data-gen\nA command line interface (CLI) to generate mock test data from a Swagger Doc\n\n**_New_**:\n - Use this project in your code! (still in beta)\n - Tries its best to give you real looking data.\n\n## Usage\n\n### CLI\nGenerate a json file filled with mock data of your API from your Swagger/OpenAPI Doc.\n - Supports both YAML and JSON Swagger/OpenAPI file formats.\n - Scans the defined definitions and creates the test data based it.\n - creates data for every definition property, not just the required fields.\n\n```shell\n# install via npm\n$: npm install swagger-data-gen -g\n\n# specified output file will br created if it does not already exist.\n$: swagger-data-gen \u003cpath-to-input-file\u003e \u003cpath-to-output-file\u003e\n\n```\n\n### Library\n\nInstall:\n```shell\n$: npm install -save swagger-data-gen\n```\n\nSimplest use case\n```ts\n// importing entire package\nimport SwaggerDataGen from 'swagger-data-gen';\n\nlet generatedData;\n\nswaggerDataGenerator.build('./samples/PetStore.yaml')\n    .then((api: Swagger) =\u003e {\n        generatedData = SwaggerDataGen.generateData(swaggerObject);\n    });\n\n// access genereated data by definition name on swagger doc\nconst petData = generatedData.pet;\n\n//-----------------------------------------------------------------------------//\n// importing specific functions\nimport { build, generate } from 'swagger-data-gen';\n\nlet generatedData;\n\nbuild('./samples/Perscription.json')\n    .then((api: Swagger) =\u003e {\n        generatedData = generateData(swaggerObject);\n    });\n\n// access genereated data by definition name on swagger doc\nconst customerData = generatedData.customer;\n```\n\n## Coming Soon\n - CLI options\n    - specify and create multiple random copies of the data\n    - each definition getting its own output file\n    - option to chose between generating all data or only required data.\n\n\n## Contribute\n - Found a problem? Submit an issue!\n - Want to contribute? Submit a PR, with a description of what you are trying to add. I would ask to focus on any of the points in **Coming Soon**\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferichenry%2Fswagger-data-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferichenry%2Fswagger-data-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferichenry%2Fswagger-data-gen/lists"}