{"id":20442664,"url":"https://github.com/swagger2markup/swagger2markup-image","last_synced_at":"2025-04-12T23:43:38.585Z","repository":{"id":90828918,"uuid":"69329324","full_name":"Swagger2Markup/swagger2markup-image","owner":"Swagger2Markup","description":"Docker image of Swagger2Markup","archived":false,"fork":false,"pushed_at":"2018-04-27T12:12:43.000Z","size":9,"stargazers_count":19,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T23:43:33.661Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Swagger2Markup.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":"2016-09-27T07:09:35.000Z","updated_at":"2025-03-05T21:41:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"a1c1b972-acd0-4419-8066-f70e4f189ec8","html_url":"https://github.com/Swagger2Markup/swagger2markup-image","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/Swagger2Markup%2Fswagger2markup-image","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Swagger2Markup%2Fswagger2markup-image/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Swagger2Markup%2Fswagger2markup-image/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Swagger2Markup%2Fswagger2markup-image/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Swagger2Markup","download_url":"https://codeload.github.com/Swagger2Markup/swagger2markup-image/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647256,"owners_count":21139081,"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-11-15T09:42:26.906Z","updated_at":"2025-04-12T23:43:38.579Z","avatar_url":"https://github.com/Swagger2Markup.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker image of Swagger2Markup\n\nSwagger2Markup is a Swagger to AsciiDoc or Markdown converter. The primary goal of Swagger2Markup is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content.\n\nSwagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.\n\nThe Swagger2Markup-CLI has been published as a Docker image on DockerHub.\n\n## Reference Documentation\n\nhttp://swagger2markup.github.io/swagger2markup/1.3.1/\n\n## Usage Guide\nYou can pull the Swagger2Markup image as follows:\n\n`docker pull swagger2markup/swagger2markup`\n\nYou can convert a Swagger Spec by running a Docker container as follows:\n\n`docker run --rm -v $(pwd):/opt swagger2markup/swagger2markup convert -i /opt/swagger.yaml -f /opt/swagger -c /opt/config.properties`\n\nYou can also run swagger2markup by shell using `bin/swagger2markup.sh` as follows:\n\n`./bin/swagger2markup convert -i /opt/swagger.yaml -f /opt/swagger -c /opt/config.properties`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger2markup%2Fswagger2markup-image","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswagger2markup%2Fswagger2markup-image","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger2markup%2Fswagger2markup-image/lists"}