{"id":15637751,"url":"https://github.com/megapixel99/yaml-readme-generator","last_synced_at":"2025-03-29T20:41:36.354Z","repository":{"id":117660073,"uuid":"250078541","full_name":"Megapixel99/YAML-README-Generator","owner":"Megapixel99","description":"If you use an OpenAPI 3.0 YAML Specification, you can run this NodeJS script to generate a preformatted list of the available routes and their response(s).","archived":false,"fork":false,"pushed_at":"2020-03-25T20:11:40.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-04T21:41:19.159Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Megapixel99.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":"2020-03-25T20:00:04.000Z","updated_at":"2020-03-25T21:32:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"f311af92-5fbb-4e18-9dd9-a2b9fcf508c7","html_url":"https://github.com/Megapixel99/YAML-README-Generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Megapixel99%2FYAML-README-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Megapixel99%2FYAML-README-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Megapixel99%2FYAML-README-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Megapixel99%2FYAML-README-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Megapixel99","download_url":"https://codeload.github.com/Megapixel99/YAML-README-Generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246243564,"owners_count":20746307,"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":[],"created_at":"2024-10-03T11:12:44.072Z","updated_at":"2025-03-29T20:41:36.340Z","avatar_url":"https://github.com/Megapixel99.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAML README Generator\n\n## Purpose/Goal\n\nIf you use an OpenAPI 3.0 YAML Specification, you can run this NodeJS script to\ngenerate a preformatted list of the available routes and their response(s).\n\n## How to initialize the project\n\nTo initialize the project run:\n\n```\n$ npm i\n```\n\n## How to run the project\n\nTo run the project you can either run with:\n\n```\n$ npm start\n```\n\nwhich will look for an `api.yaml` file in the root directory of the project, or\nyou can run the project with:\n\n```\n$ npm start ./api.yaml ./schema.yaml ./other.yaml\n```\n\nwhich will look for all of the yaml files specified as command line arguments.\nUpon running the project the specification for the yaml file(s), the program\nwill output to the Terminal/Command Prompt and will need to be copied to the\nappropriate README file.\n\n### Or\n\nYou can run the project with\n\n```\n$ node ./index.js\n```\nor\n\n```\n$ node ./index.js ./api.yaml ./schema.yaml ./other.yaml\n```\n\n#### Please see `ExampleOutput.md` for an example of the output, which was generated with the command:\n\n```\n$ npm start ./api.yaml ./views.yaml\n```\n\n##### Contributions are appreciated\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegapixel99%2Fyaml-readme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmegapixel99%2Fyaml-readme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegapixel99%2Fyaml-readme-generator/lists"}