{"id":21050682,"url":"https://github.com/sandcastle/swagger-codegen-docker","last_synced_at":"2025-03-13T23:14:18.269Z","repository":{"id":66956502,"uuid":"42119774","full_name":"sandcastle/swagger-codegen-docker","owner":"sandcastle","description":"Docker container for running swagger-codegen during builds","archived":false,"fork":false,"pushed_at":"2015-09-09T01:46:57.000Z","size":168,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-20T18:34:59.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sandcastle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-08T15:02:36.000Z","updated_at":"2016-10-24T16:03:49.000Z","dependencies_parsed_at":"2023-02-28T02:31:26.745Z","dependency_job_id":null,"html_url":"https://github.com/sandcastle/swagger-codegen-docker","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/sandcastle%2Fswagger-codegen-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandcastle%2Fswagger-codegen-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandcastle%2Fswagger-codegen-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandcastle%2Fswagger-codegen-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sandcastle","download_url":"https://codeload.github.com/sandcastle/swagger-codegen-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243495496,"owners_count":20299923,"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-19T15:46:57.699Z","updated_at":"2025-03-13T23:14:18.248Z","avatar_url":"https://github.com/sandcastle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-codegen-docker\n\u003e Container for building swagger code\n\n## Getting Started\n\n### Docker Image\n\nBefore you can generate code, you first need to aquire the docker image.\n\n#### Local Build\n\nTo build the image from source, run the following command:\n\n```sh\nsh script/build\n```\n\n#### DockerHub\n\nTo pull the latest version of the image from DockerHub, run the following command:\n\n```sh\ndocker pull sandcastle/swagger-codegen-docker\n```\n\n### Usage\n\nTo generate swagger output - run the following docker command:\n\n```sh\ndocker run \\\n    -v \"${PWD}/spec:/spec\" \\\n    -v \"${PWD}/tmp/output/html:/gen\" \\\n    -e \"LANGUAGE=dynamic-html\" \\\n    -e \"SWAGGER_FILE=swagger.yml\" \\\n    sandcastle/swagger-codegen-docker\n```\n\nBelow explains what each line does:\n\n- `-v \"${PWD}/spec:/spec\" \\` - maps the local spec folder (`${PWD}/spec`) to the internal spec folder (`/spec`)\n- `-v \"${PWD}/tmp/output/html:/gen\" \\` - maps the local output folder (`${PWD}/tmp/output/html`) to the internal output folder (`/gen`)\n- `-e \"LANGUAGE=dynamic-html\" \\` - the language to generate the output in (see below)\n- `-e \"SWAGGER_FILE=swagger.yml\" \\` - the name of the swagger file (within the `/spec` volume above)\n- `sandcastle/swagger-codegen-docker` - the name of the docker image to run\n\n\n## Available Languages\n\nThe following languages are available for generation:\n\n- android\n- async-scala\n- csharp\n- flash\n- java\n- jaxrs\n- inflector\n- nodejs\n- objc\n- perl\n- php\n- python\n- python3\n- qt5cpp\n- retrofit\n- ruby\n- scala\n- scalatra\n- silex-PHP\n- sinatra\n- spring-mvc\n- dynamic-html\n- html\n- swagger\n- swagger-yaml\n- swift\n- tizen\n- typescript-angular\n- typescript-node\n- akka-scala\n- CsharpDotNet2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandcastle%2Fswagger-codegen-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandcastle%2Fswagger-codegen-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandcastle%2Fswagger-codegen-docker/lists"}