{"id":13801674,"url":"https://github.com/rmariuzzo/markdown-swagger","last_synced_at":"2025-03-16T10:31:52.259Z","repository":{"id":143889219,"uuid":"97530687","full_name":"rmariuzzo/markdown-swagger","owner":"rmariuzzo","description":"Generate API docs from Swagger file into markdown file.","archived":false,"fork":false,"pushed_at":"2018-09-28T20:18:01.000Z","size":247,"stargazers_count":72,"open_issues_count":3,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-15T00:27:21.085Z","etag":null,"topics":["markdown","swagger-api"],"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/rmariuzzo.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}},"created_at":"2017-07-17T23:20:51.000Z","updated_at":"2023-08-30T12:37:55.000Z","dependencies_parsed_at":"2024-01-13T10:41:58.629Z","dependency_job_id":"6cdd21ab-7cde-439d-bfac-2ca196851428","html_url":"https://github.com/rmariuzzo/markdown-swagger","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmariuzzo","download_url":"https://codeload.github.com/rmariuzzo/markdown-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814895,"owners_count":20352036,"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":["markdown","swagger-api"],"created_at":"2024-08-04T00:01:25.726Z","updated_at":"2025-03-16T10:31:51.980Z","avatar_url":"https://github.com/rmariuzzo.png","language":"JavaScript","readme":"\u003cdiv align=center\u003e\n  \u003ch1\u003eMarkdown Swagger\u003c/h1\u003e\n  \u003cp\u003eGenerate API docs from Swagger file into markdown file.\u003c/p\u003e\n\u003c/div\u003e\n\n![Mardown Swagger Example](.github/banner.png)\n\n## Installation\n\n```shell\nnpm install markdown-swagger\n```\n\n### Usage\n\n```shell\nmarkdown-swagger ./api/swagger/swagger.yaml ./README.md\n```\n\nThis will read the specified swagger file and generate a table describing the API inside the target markdown file.\n\nThe `markdown-swagger` script will look for the for the following piece of text inside the target markdown file to do its stuff:\n\n```markdown\n\u003c!-- markdown-swagger --\u003e\n  Everything here will be replaced by markdown-swagger\n\u003c!-- /markdown-swagger --\u003e\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariuzzo%2Fmarkdown-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmariuzzo%2Fmarkdown-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariuzzo%2Fmarkdown-swagger/lists"}