You also need to set an environment variable for SCALA_HOME:

export SCALA_HOME={PATH_TO_YOUR_SCALA_DEPLOYMENT}

If you don't have the Apache Ivy dependency manager installed, run this build script:

ant -f install-ivy

This will copy the ivy ant lib into your antlib directory. Now you can build the artifact:

ant

This will create the swagger-codegen library in your build folder.

./bin/generate-java-lib.sh {server-url} {api_key} {output-package} {output-dir}

for example:

./bin/generate-java-lib.sh http://petstore.swagger.wordnik.com/api/ special-key com.foo.mydriver generated-files

./bin/generate-scala-lib.sh http://petstore.swagger.wordnik.com/api "" "client" "generated-files"

./bin/generate-js-lib.sh http://petstore.swagger.wordnik.com/api "" "" "generated-files"

./bin/generate-as3-lib.sh http://petstore.swagger.wordnik.com/api "" "client" "generated-files"

./bin/generate-php-lib.sh http://petstore.swagger.wordnik.com/api "" "client" "generated-files"

./bin/generate-python-lib.sh http://petstore.swagger.wordnik.com/api "" "client" "generated-files"

The main class for the generator is at src/main/java/com/wordnik/swagger/codegen/config/java/JavaLibCodeGen.java

The code-gen uses the antlr string template library for generating the output files, please look at http://www.stringtemplate.org for details on the antlr framework.

The Wordnik team is working on generating libraries for Ruby, ActionScript 3, Android, PHP and JavaScript, which will be open-sourced in the coming weeks

The testing framework helps you to test Swagger generated client libraries using declarative test scripts. The same scripts can be used to test client libraries in different languages. The framework can be used for client and server regression testing.

For Example, first build the client library from the sample app:

./bin/generate-java-lib.sh http://petstore.swagger.wordnik.com/api/ special-key com.foo.mydriver generated-files

Use the sample build script to build a jar from the client files:

cp conf/java/sample/*.xml ./generated-files

cd generated-files

ant

This creates a complete client library jar. You can now run the tests:

./bin/test-java-lib.sh http://petstore.swagger.wordnik.com/api/ special-key conf/java/sample/lib-test-script.json \
    conf/java/sample/lib-test-data.json com.foo.mydriver.model.TestData com.foo.mydriver.api \
    generated-files/build/swagger-sample-java-lib-1.0.jar

Summary -->  Total Test Cases: 9 Failed Test Cases: 0
Details: 
1.1 : Create User :  passed  
 
1.2 : Login User :  passed  
 
1.3 : Find user by name :  passed  
 
1.4 : Delete user by name :  passed  
 
2.1 : Add pet :  passed  
 
2.2 : Find pet by id :  passed  
 
2.3 : Find pet by status :  passed  
 
3.1 : Find order by id :  passed  
 
3.2 : Place order :  passed 

In detail, there are two components in the test framework:

Test script is written in JSON structure. The JSON consists of following elements:

Each assertion contains

Test data file is documented using a Test Data Object which is generated as part of Java client library code-gen. This class provides list getters and setters for each model object available in the resource description. It is called "TestData" and it is available in model package of the java library code generation output.

Chaining results of test cases:

${input.

${input.userList[0]}

${input.userList[0].username}

${output.

${output(1.2)}

${output(1.1).username}

A Summary will be reported with each test run. For instance:

Sample: "Summary -->  Total Test Cases: 9 Failed Test Cases: 0"

In detail section each test case and its status (passed/failed) are reported. Failures include an exception trace. Test case path is combination of test suite id and test case id separated by "."