swagger-api · BastiOfBerlin · May 24, 2016 · May 24, 2016 · May 24, 2016 · May 25, 2016
diff --git a/.dockerignore b/.dockerignore
@@ -1,3 +1,4 @@
+.git/
 *.iml
 out/
 *.ipr
@@ -13,35 +14,13 @@ generated-sources/*
 generated-code/*
 *.swp
 *.swo
-
-/target
-/generated-files
-/nbactions.xml
-*.pyc
-__pycache__
-samples/server-generator/scalatra/output
-samples/server-generator/node/output/node_modules
-samples/server-generator/scalatra/target
-samples/server-generator/scalatra/output/.history
-samples/client/petstore/qt5cpp/PetStore/moc_*
-samples/client/petstore/qt5cpp/PetStore/*.o
-samples/client/petstore/objc/PetstoreClient.xcworkspace/xcuserdata
-samples/client/petstore/qt5cpp/build-*
-samples/client/petstore/qt5cpp/PetStore/PetStore
-samples/client/petstore/qt5cpp/PetStore/Makefile
-samples/client/petstore/java/hello.txt
-samples/client/petstore/android/default/hello.txt
-samples/client/petstore/objc/Build
-samples/client/petstore/objc/Pods
-samples/server/petstore/nodejs/node_modules
-target
-.idea
-.lib
-atlassian-ide-plugin.xml
+*.bak
+project/
+samples/*
+target/
+.idea/
+.lib/
 .DS_Store
 
-samples/client/petstore/php/SwaggerClient-php/composer.lock
-samples/client/petstore/php/SwaggerClient-php/vendor/
-
-samples/client/petstore/silex/SwaggerServer/composer.lock
-samples/client/petstore/silex/SwaggerServer/venodr/
+# Not needed in a linux container
+bin/windows/*
diff --git a/.travis.yml b/.travis.yml
@@ -24,6 +24,12 @@ before_install:
   - docker pull swaggerapi/petstore
   - docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore
   - docker ps -a
+  # Add bats test framework and cURL for Bash script integration tests
+  - sudo add-apt-repository ppa:duggan/bats --yes
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq bats
+  - sudo apt-get install -qq curl
+
   # show host table to confirm petstore.swagger.io is mapped to localhost
   - cat /etc/hosts
 
@@ -34,7 +40,15 @@ install:
    - export PATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace/bin:$PATH"
 
 script:
+  # fail fast
+  - set -e
+  # fail if templates/generators contain carriage return '\r'
+  - /bin/bash ./bin/utils/detect_carriage_return.sh
+  # fail if generators contain tab '\t'
+  - /bin/bash ./bin/utils/detect_tab_in_java_class.sh
+  # run integration tests defined in maven pom.xml
   - mvn verify -Psamples
+  # docker test
   - if [ $DOCKER_HUB_USERNAME ]; then docker login --email=$DOCKER_HUB_EMAIL --username=$DOCKER_HUB_USERNAME --password=$DOCKER_HUB_PASSWORD && docker build -t $DOCKER_IMAGE_NAME ./modules/swagger-generator && if [ ! -z "$TRAVIS_TAG" ]; then docker tag $DOCKER_IMAGE_NAME:latest $DOCKER_IMAGE_NAME:$TRAVIS_TAG; fi && docker push $DOCKER_IMAGE_NAME; fi
 
 env:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -30,6 +30,7 @@ For a list of variables available in the template, please refer to this [page](h
 ### Style guide
 Code change should conform to the programming style guide of the respective languages:
 - Android: https://source.android.com/source/code-style.html
+- Bash: https://github.com/bahamas10/bash-style-guide
 - C#: https://msdn.microsoft.com/en-us/library/vstudio/ff926074.aspx
 - C++: https://google.github.io/styleguide/cppguide.html
 - Clojure: https://github.com/bbatsov/clojure-style-guide
@@ -75,3 +76,5 @@ To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all t
 - Document the fix in the code to make the code more readable
 - Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests)
 - File a PR with meaningful title, description and commit messages. A good example is [PR-3306](https://github.com/swagger-api/swagger-codegen/pull/3306)
+- Recommended git settings
+   - `git config --global core.autocrlf input` to tell Git convert CRLF to LF on commit but not the other way around 
diff --git a/Dockerfile b/Dockerfile
@@ -1,13 +1,22 @@
-FROM maven:3.3-jdk-7
+FROM jimschubert/8-jdk-alpine-mvn:1.0
 
-WORKDIR /src
-VOLUME  /src
-VOLUME  /root/.m2/repository
+ENV GEN_DIR /opt/swagger-codegen
 
-ADD . /opt/swagger-codegen
+RUN set -x && \
+    apk add --no-cache bash
 
-RUN cd /opt/swagger-codegen && mvn package
+RUN mkdir /opt
 
-ENTRYPOINT ["java", "-jar", "/opt/swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"]
+ADD . ${GEN_DIR}
 
-CMD ["help"]
+VOLUME  ${MAVEN_HOME}/.m2/repository
+
+WORKDIR ${GEN_DIR}
+
+RUN mvn -am -pl "modules/swagger-codegen-cli" package
+
+COPY docker-entrypoint.sh /usr/local/bin/
+
+ENTRYPOINT ["docker-entrypoint.sh"]
+
+CMD ["build"]
diff --git a/README.md b/README.md
@@ -15,8 +15,8 @@
 ## Overview
 This is the swagger codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported:
 
-- **API clients**: **ActionScript**, **C#** (.net 2.0, 4.0 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Go**, **Groovy**, **Haskell**, **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign), **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations) **Objective-C**, **Perl**, **PHP**, **Python**, **Ruby**, **Scala**, **Swift** (2.x, 3.x), **Typescript** (Angular1.x, Angular2.x, Fetch, Node)
-- **Server stubs**: **C#** (ASP.NET Core, NancyFx), **Erlang**, **Go**, **Haskell**, **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy), **PHP** (Lumen, Slim, Silex), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Scala** (Scalatra)
+- **API clients**: **ActionScript**, **Bash**, **C#** (.net 2.0, 4.0 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Elixir**, **Go**, **Groovy**, **Haskell**, **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign), **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations) **Objective-C**, **Perl**, **PHP**, **Python**, **Ruby**, **Scala**, **Swift** (2.x, 3.x), **Typescript** (Angular1.x, Angular2.x, Fetch, Node)
+- **Server stubs**: **C#** (ASP.NET Core, NancyFx), **Erlang**, **Go**, **Haskell**, **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy), **PHP** (Lumen, Slim, Silex, [Zend Expressive](https://github.com/zendframework/zend-expressive)), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Scala** ([Finch](https://github.com/finagle/finch), Scalatra)
 - **API documentation generators**: **HTML**, **Confluence Wiki** 
 - **Others**: **JMeter**
 
@@ -110,16 +110,41 @@ After cloning the project, you can build it from source with this command:
 mvn clean package
 ```
 
+### Homebrew
+
+To install, run `brew install swagger-codegen`
+
+Here is an example usage:
+```
+swagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/
+```
+
 ### Docker
-#### Build and run using docker
+
+#### Development in docker
+
+You can use `run-in-docker.sh` to do all development. This script maps your local repository to `/gen`
+in the docker container. It also maps `~/.m2/repository` to the appropriate container location.
+
+To execute `mvn package`:
 
 ```
 git clone https://github.com/swagger-api/swagger-codegen
 cd swagger-codegen
 ./run-in-docker.sh mvn package
- ```
+```
 
+Build artifacts are now accessible in your working directory.
 
+Once 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:
+
+```
+./run-in-docker.sh help # Executes 'help' command for swagger-codegen-cli
+./run-in-docker.sh langs # Executes 'langs' command for swagger-codegen-cli
+./run-in-docker.sh /gen/bin/go-petstore.sh  # Builds the Go client
+./run-in-docker.sh generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml \
+    -l go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore
+```
 
 #### Run Docker in Vagrant
 Prerequisite: install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads).
@@ -132,18 +157,54 @@ cd /vagrant
 ./run-in-docker.sh mvn package
  ```
 
-#### Public Docker image
+#### Public Pre-built Docker images
 
- - https://hub.docker.com/r/swaggerapi/swagger-generator/ (official)
- - https://hub.docker.com/r/jimschubert/swagger-codegen-cli/ (unofficial)
+ - https://hub.docker.com/r/swaggerapi/swagger-generator/ (official web service)
+ - https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/ (official CLI)
+=======
 
-### Homebrew
-To install, run `brew install swagger-codegen`
+##### Swagger Generator Docker Image
+
+The Swagger Generator image can act as a self-hosted web application and API for generating code. This container can be  incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.
+
+Example usage (note this assumes `jq` is installed for command line processing of JSON):
 
-Here is an example usage:
 ```
-swagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/
+# Start container and save the container id
+CID=$(docker run -d swaggerapi/swagger-generator)
+# allow for startup
+sleep 5
+# Get the IP of the running container
+GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'  $CID)
+# Execute an HTTP request and store the download link
+RESULT=$(curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
+  "swaggerUrl": "http://petstore.swagger.io/v2/swagger.json"
+}' 'http://localhost:8188/api/gen/clients/javascript' | jq '.link' | tr -d '"')
+# Download the generated zip and redirect to a file
+curl $RESULT > result.zip
+# Shutdown the swagger generator image
+docker stop $CID && docker rm $CID
+```
+
+In the example above, `result.zip` will contain the generated client.
+
+##### Swagger Codegen Docker Image
+
+The 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.
+
+To generate code with this image, you'll need to mount a local location as a volume.
+
+Example:
+
 ```
+docker run --rm -v ${PWD}:/local swagger-api/swagger-codegen generate \
+    -i http://petstore.swagger.io/v2/swagger.json \
+    -l go \
+    -o /local/out/go
+```
+
+The generated code will be located under `./out/go` in the current directory.
+
 ## Getting Started
 
 To generate a PHP client for http://petstore.swagger.io/v2/swagger.json, please run the following
@@ -289,6 +350,10 @@ OPTIONS
             the format of swaggerType=generatedType,swaggerType=generatedType.
             For example: array=List,map=Map,string=String
 
+        --reserved-words-mappings <import mappings>
+            specifies how a reserved name should be escaped to. Otherwise, the
+            default _<name> is used. For example id=identifier
+
         -v, --verbose
             verbose mode
 
@@ -331,6 +396,10 @@ You would then compile your library in the `output/myLibrary` folder with `mvn p
 ```
 java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen
 ```
+For Windows users, you will need to use `;` instead of `:` in the classpath, e.g.
+```
+java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar;modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen
+```
 
 Note the `myClientCodegen` is an option now, and you can use the usual arguments for generating your library:
 
@@ -459,6 +528,7 @@ AndroidClientCodegen.java
 AspNet5ServerCodegen.java
 AspNetCoreServerCodegen.java
 AsyncScalaClientCodegen.java
+BashClientCodegen.java
 CSharpClientCodegen.java
 ClojureClientCodegen.java
 CsharpDotNet2ClientCodegen.java
@@ -784,25 +854,32 @@ Here are some companies/projects using Swagger Codegen in production. To add you
 - [goTransverse](http://www.gotransverse.com/api)
 - [GraphHopper](https://graphhopper.com/)
 - [Gravitate Solutions](http://gravitatesolutions.com/)
+- [Hewlett Packard Enterprise](https://hpe.com)
+- [High Technologies Center](http://htc-cs.com)
 - [IMS Health](http://www.imshealth.com/en/solution-areas/technology-and-applications)
 - [Intent HQ](http://www.intenthq.com)
 - [Interactive Intelligence](http://developer.mypurecloud.com/)
 - [Kabuku](http://www.kabuku.co.jp/en)
+- [Kurio](https://kurio.co.id)
 - [Kuroi](http://kuroiwebdesign.com/)
 - [Kuary](https://kuary.com/)
+- [Kubernetes](https://kubernetes.io/)
 - [LANDR Audio](https://www.landr.com/)
 - [Lascaux](http://www.lascaux.it/)
 - [Leica Geosystems AG](http://leica-geosystems.com)
 - [LiveAgent](https://www.ladesk.com/)
 - [LXL Tech](http://lxltech.com)
+- [MailMojo](https://mailmojo.no/)
 - [Mindera](http://mindera.com/)
 - [Mporium](http://mporium.com/)
+- [Neverfail](https://neverfail.com/)
 - [nViso](http://www.nviso.ch/)
 - [Okiok](https://www.okiok.com)
 - [Onedata](http://onedata.org)
 - [OrderCloud.io](http://ordercloud.io)
 - [OSDN](https://osdn.jp)
 - [PagerDuty](https://www.pagerduty.com)
+- [PagerTree](https://pagertree.com)
 - [Pepipost](https://www.pepipost.com)
 - [Plexxi](http://www.plexxi.com)
 - [Pixoneye](http://www.pixoneye.com/)
@@ -819,9 +896,12 @@ Here are some companies/projects using Swagger Codegen in production. To add you
 - [Saritasa](https://www.saritasa.com/)
 - [SCOOP Software GmbH](http://www.scoop-software.de)
 - [Shine Solutions](https://shinesolutions.com/)
+- [Simpfony](https://www.simpfony.com/)
 - [Skurt](http://www.skurt.com)
+- [Slamby](https://www.slamby.com/)
 - [SmartRecruiters](https://www.smartrecruiters.com/)
 - [snapCX](https://snapcx.io)
+- [SPINEN](http://www.spinen.com)
 - [SRC](https://www.src.si/)
 - [StyleRecipe](http://stylerecipe.co.jp)
 - [Svenska Spel AB](https://www.svenskaspel.se/)
@@ -832,6 +912,7 @@ Here are some companies/projects using Swagger Codegen in production. To add you
 - [VMware](https://vmware.com/)
 - [W.UP](http://wup.hu/?siteLang=en)
 - [Wealthfront](https://www.wealthfront.com/)
+- [Webever GmbH](https://www.webever.de/)
 - [WEXO A/S](https://www.wexo.dk/)
 - [Zalando](https://tech.zalando.com)
 - [ZEEF.com](https://zeef.com/)
@@ -882,15 +963,19 @@ Swagger Codegen core team members are contributors who have been making signific
 | Python Flask  |  |
 | Ruby Sinatra     | @wing328 (2016/05/01) |  |
 | Scala Scalatra |  |  |
+| Scala Finch | @jimschubert (2017/01/28) |
+
 
 ## Template Creator
 Here is a list of template creators:
  * API Clients:
    * Akka-Scala: @cchafer
+   * Bash: @bkryza
    * C++ REST: @Danielku15
    * C# (.NET 2.0): @who
    * Clojure: @xhh
    * Dart: @yissachar
+   * Elixir: @niku
    * Groovy: @victorgit
    * Go: @wing328
    * Java (Feign): @davidkiss
@@ -922,7 +1007,9 @@ Here is a list of template creators:
    * JAX-RS CXF (CDI): @nickcmaynard
    * PHP Lumen: @abcsum
    * PHP Slim: @jfastnacht
+   * PHP Zend Expressive (with Path Handler): @Articus
    * Ruby on Rails 5: @zlx
+   * Scala Finch: @jimschubert
  * Documentation
    * HTML Doc 2: @jhitchcock
    * Confluence Wiki: @jhitchcock
@@ -972,7 +1059,7 @@ When code is generated from this project, it shall be considered **AS IS** and o
 License
 -------
 
-Copyright 2016 SmartBear Software
+Copyright 2017 SmartBear Software
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/bin/bash-petstore.sh b/bin/bash-petstore.sh
@@ -0,0 +1,31 @@
+#!/bin/sh
+
+SCRIPT="$0"
+
+while [ -h "$SCRIPT" ] ; do
+  ls=`ls -ld "$SCRIPT"`
+  link=`expr "$ls" : '.*-> \(.*\)$'`
+  if expr "$link" : '/.*' > /dev/null; then
+    SCRIPT="$link"
+  else
+    SCRIPT=`dirname "$SCRIPT"`/"$link"
+  fi
+done
+
+if [ ! -d "${APP_DIR}" ]; then
+  APP_DIR=`dirname "$SCRIPT"`/..
+  APP_DIR=`cd "${APP_DIR}"; pwd`
+fi
+
+executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
+args="$@ generate -t modules/swagger-codegen/src/main/resources/bash -i modules/swagger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -l bash -o samples/client/petstore/bash -c modules/swagger-codegen/src/test/resources/2_0/bash-config.json"
+
+java $JAVA_OPTS -jar $executable $args