[{"_1":2,"_175":-5,"_176":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_150":151},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_139":-5,"_140":11,"_141":21,"_142":11,"_143":-5,"_144":11,"_145":-5,"_146":147,"_148":91,"_149":-7},"canonicalUrl","https://hub.docker.com/r/jasiek/swagger-codegen/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","jasiek","reponame","swagger-codegen","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2018-10-16T12:50:31.066217Z","description","Build process for building v3.0.0","is_private","last_updated","2018-10-16T15:36:59.805496Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",240,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Swagger Code Generator V3\n\n## Overview\nThis is the swagger codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Definition](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported:\n\n- **API clients**: **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java)\n- **Server stubs**: **Java** (Inflector)\n- **API documentation generators**: **HTML**, **Confluence Wiki**\n- **Configuration files**: [**Apache2**](https://httpd.apache.org/)\n- **Others**: **JMeter**\n\nCheck out [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) for additional information about the OpenAPI project.\n\n# Table of contents\n\n - [Swagger Code Generator](#swagger-code-generator)\n - [Overview](#overview)\n - [Table of Contents](#table-of-contents)\n - Installation\n - [Compatibility](#compatibility)\n - [Prerequisites](#prerequisites)\n - [OS X Users](#os-x-users)\n - [Building](#building)\n - [Docker](#docker)\n - [Development in Docker](#development-in-docker)\n - [Run docker in Vagrant](#run-docker-in-vagrant)\n - [Public Docker image](#public-docker-image)\n - [Homebrew](#homebrew)\n - [Getting Started](#getting-started)\n - Generators\n - [To generate a sample client library](#to-generate-a-sample-client-library)\n - [Generating libraries from your server](#generating-libraries-from-your-server)\n - [Modifying the client library format](#modifying-the-client-library-format)\n - [Making your own codegen modules](#making-your-own-codegen-modules)\n - [Generating a client from local files](#generating-a-client-from-local-files)\n - [Customizing the generator](#customizing-the-generator)\n - [Validating your OpenAPI Spec](#validating-your-openapi-spec)\n - [Generating dynamic html api documentation](#generating-dynamic-html-api-documentation)\n - [To build a server stub](#to-build-a-server-stub)\n - [To build the codegen library](#to-build-the-codegen-library)\n - [Workflow Integration](#workflow-integration)\n - [Maven Integration](#maven-integration)\n - [Gradle Integration](#gradle-integration)\n - [Github Integration](#github-integration)\n - [Online Generators](#online-generators)\n - [Guidelines for Contribution](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md#guidelines-for-contributing)\n - [License](#license)\n\n\n## Compatibility\nThe OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The swagger-codegen project has the following compatibilities with the OpenAPI Specification:\n\nSwagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes\n-------------------------- | ------------ | -------------------------- | -----\n[3.0.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.0)(https://oss.sonatype.org/content/repositories/releases/io/swagger/codegen/v3/swagger-codegen-cli/3.0.0/)| 2018-09-06 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes\n2.4.0 (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/swagger-codegen-cli/2.4.0-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0 | Minor release with breaking changes\n[2.3.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.1) (**current stable**) | 2018-01-17 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.1](https://github.com/swagger-api/swagger-codegen/tree/v2.3.1)\n[2.3.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.0) | 2017-12-21 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.0](https://github.com/swagger-api/swagger-codegen/tree/v2.3.0)\n[2.2.3](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.3) | 2017-07-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.3](https://github.com/swagger-api/swagger-codegen/tree/v2.2.3)\n[2.2.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.2) | 2017-03-01 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.2](https://github.com/swagger-api/swagger-codegen/tree/v2.2.2)\n[2.2.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.1) | 2016-08-07 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.1](https://github.com/swagger-api/swagger-codegen/tree/v2.2.1)\n[2.1.6](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.1.6) | 2016-04-06 | 1.0, 1.1, 1.2, 2.0 | [tag v2.1.6](https://github.com/swagger-api/swagger-codegen/tree/v2.1.6)\n2.0.17 | 2014-08-22 | 1.1, 1.2 | [tag v2.0.17](https://github.com/swagger-api/swagger-codegen/tree/2.0.17)\n1.0.4 | 2012-04-12 | 1.0, 1.1 | [tag v1.0.4](https://github.com/swagger-api/swagger-codegen/tree/swagger-codegen_2.9.1-1.1)\n\n\n### Prerequisites\nIf you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):\n\n```sh\nwget http://central.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.0/swagger-codegen-cli-3.0.0.jar -O swagger-codegen-cli.jar\n\njava -jar swagger-codegen-cli.jar --help\n```\n\nFor Windows users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g. `Invoke-WebRequest -OutFile swagger-codegen-cli.jar http://central.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.0/swagger-codegen-cli-3.0.0.jar`\n\nOn a mac, it's even easier with `brew`:\n```sh\nbrew install swagger-codegen\n```\n\nTo build from source, you need the following installed and available in your $PATH:\n\n* [Java 8](http://java.oracle.com)\n\n* [Apache maven 3.3.3 or greater](http://maven.apache.org/)\n\n#### OS X Users\nDon't forget to install Java 8. You probably have 1.6 or 1.7.\n\nExport JAVA_HOME in order to use the supported Java version:\n```sh\nexport JAVA_HOME=`/usr/libexec/java_home -v 1.8`\nexport PATH=${JAVA_HOME}/bin:$PATH\n```\n\n### Building\n\nAfter cloning the project, you can build it from source with this command:\n```sh\nmvn clean package\n```\n\n### Homebrew\n\nTo install, run `brew install swagger-codegen`\n\nHere is an example usage:\n```sh\nswagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/\n```\n\n### Docker\n\n#### Development in docker\n\nYou can use `run-in-docker.sh` to do all development. This script maps your local repository to `/gen`\nin the docker container. It also maps `~/.m2/repository` to the appropriate container location.\n\nTo execute `mvn package`:\n\n```sh\ngit clone https://github.com/swagger-api/swagger-codegen\ncd swagger-codegen\n./run-in-docker.sh mvn package\n```\n\nBuild artifacts are now accessible in your working directory.\n\nOnce built, `run-in-docker.sh` will act as an executable for swagger-codegen-cli. To generate code, you'll need to output to a directory under `/gen` (e.g. `/gen/out`). For example:\n\n```sh\n./run-in-docker.sh help # Executes 'help' command for swagger-codegen-cli\n./run-in-docker.sh langs # Executes 'langs' command for swagger-codegen-cli\n./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client\n./run-in-docker.sh generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml \\\n -l go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore\n```\n\n#### Run Docker in Vagrant\nPrerequisite: install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads).\n ```sh\ngit clone http://github.com/swagger-api/swagger-codegen.git\ncd swagger-codegen\nvagrant up\nvagrant ssh\ncd /vagrant\n./run-in-docker.sh mvn package\n ```\n\n#### Public Pre-built Docker images\n\n - https://hub.docker.com/r/swaggerapi/swagger-generator-v3/ (official web service)\n - https://hub.docker.com/r/swaggerapi/swagger-generator-v3-minimal/ (official minimal web service)\n - https://hub.docker.com/r/swaggerapi/swagger-codegen-cli-v3/ (official CLI)\n\n\n##### Swagger Generator Docker Image\n\nSee also [online generators](#online-generators)\nThe Swagger Generator image provides a ready to use web application (swagger-generator) providing code generation services.\n\nImage accepts the following env variables:\nJAVA_MEM e.g. 1024m\n\n- `HTTP_PORT` e.g. `8080`\n- `HIDDEN_OPTIONS_PATH` (alternative to `HIDDEN_OPTIONS`): useful if attaching a volume containing a `hiddenOptions.yaml` file definining which languages to hide. e.g. `/data/hiddenOptions.yaml`\n- `HIDDEN_OPTIONS` (alternative to `HIDDEN_OPTIONS_PATH`): allows to pass hidden options as an env variable, in the format `{category}:{language},{language},{language}|{category}:{language},{language},{language}`\ne.g. `servers:foo,bar|clientsV3:wtf,isthis` where category can be `clients`, `servers`, `clientsV3`, `serversV3`\n\nAn example of running the container:\n\n`docker pull swaggerapi/swagger-generator-v3`\n\n`docker run -e \"HIDDEN_OPTIONS=servers:foo,bar|clientsV3:fgf,sdsd\" -e \"JAVA_MEM=1024m\" -e \"HTTP_PORT=80\" -p 80:80 --name swagger-generator-v3 swaggerapi/swagger-generator-v3`\n\nor\n\n`docker run -e \"HIDDEN_OPTIONS_PATH=/hiddenOptions.yaml\" -e \"JAVA_MEM=1024m\" -e \"HTTP_PORT=80\" -p 80:80 --name swagger-generator-v3 swaggerapi/swagger-generator-v3`\n\n##### Swagger Generator \"Minimal\" Docker Image\n\nSee also [online generators](#online-generators)\n\nThe Swagger Generator \"Minimal\" image can act as a self-hosted web application and API for generating code.\n\nThis container can be incorporated into a CI pipeline, and requires some docker orchestration to access generated code.\n\nExample usage:\n\n```sh\n# Start container and save the container id\nCID=$(docker run -d swaggerapi/swagger-generator-v3-minimal)\n# allow for startup\nsleep 5\n# Get the IP of the running container\nGEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID)\n# Execute an HTTP request and store the download link\ncurl -X POST \\\n http://localhost:8080/api/generate \\\n -H 'content-type: application/json' \\\n -d '{\n \"specURL\" : \"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml\",\n \"lang\" : \"jaxrs-jersey\",\n \"type\" : \"SERVER\",\n \"codegenVersion\" : \"V3\"\n }' > result.zip\n# Shutdown the swagger generator image\ndocker stop $CID && docker rm $CID\n```\n\nIn the example above, `result.zip` will contain the generated client.\n\n##### Swagger Codegen CLI Docker Image\n\nThe Swagger Codegen image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.\n\nTo generate code with this image, you'll need to mount a local location as a volume.\n\nExample:\n\n```sh\ndocker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli-v3 generate \\\n -i http://petstore.swagger.io/v2/swagger.json \\\n -l go \\\n -o /local/out/go\n```\n\nThe generated code will be located under `./out/go` in the current directory.\n\n## Getting Started\n\nTo generate a PHP client for http://petstore.swagger.io/v2/swagger.json, please run the following\n```sh\ngit clone https://github.com/swagger-api/swagger-codegen\ncd swagger-codegen\ngit checkout 3.0.0\nmvn clean package\njava -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \\\n -i http://petstore.swagger.io/v2/swagger.json \\\n -l php \\\n -o /var/tmp/php_api_client\n```\n(if you're on Windows, replace the last command with `java -jar modules\\swagger-codegen-cli\\target\\swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l php -o c:\\temp\\php_api_client`)\n\nYou can also download the JAR (latest release) directly from [maven.org](http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.0/swagger-codegen-cli-2.3.0.jar)\n\nTo get a list of **general** options available, please run `java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar help generate`\n\nTo get a list of PHP specified options (which can be passed to the generator with a config file via the `-c` option), please run `java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php`\n\n## Generators\n\n### To generate a sample client library\nYou can build a client against the swagger sample [petstore](http://petstore.swagger.io) API as follows:\n\n```sh\n./bin/java-petstore.sh\n```\n\n(On Windows, run `.\\bin\\windows\\java-petstore.bat` instead)\n\nThis will run the generator with this command:\n\n```sh\njava -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \\\n -i http://petstore.swagger.io/v2/swagger.json \\\n -l java \\\n -o samples/client/petstore/java\n```\n\nwith a number of options. You can get the options with the `help generate` command (below only shows partal results):\n\n```\nNAME\n swagger-codegen-cli generate - Generate code with chosen lang\n\nSYNOPSIS\n swagger-codegen-cli generate\n [(-a | --auth )]\n [--additional-properties ...]\n [--api-package ] [--artifact-id ]\n [--artifact-version ]\n [(-c | --config )]\n [-D ...] [--git-repo-id ]\n [--git-user-id ] [--group-id ]\n [--http-user-agent ]\n (-i | --input-spec )\n [--ignore-file-override ]\n [--import-mappings ...]\n [--instantiation-types ...]\n [--invoker-package ]\n (-l | --lang )\n [--language-specific-primitives ...]\n [--library ] [--model-name-prefix ]\n [--model-name-suffix ]\n [--model-package ]\n [(-o | --output )]\n [--release-note ] [--remove-operation-id-prefix]\n [--reserved-words-mappings ...]\n [(-s | --skip-overwrite)]\n [(-t

jasiek/swagger-codegen

Tags for jasiek/swagger-codegen