bin | ||
samples/petstore | ||
src | ||
.gitignore | ||
pom.xml | ||
README.md |
Swagger Client Code-Generator
Overview
This is a project to build the Swagger code-gen library which can be used to automatically generate client libraries from a Swagger-compliant server. You can find out more about both the spec and the framework at http://swagger.wordnik.com. For more information about Wordnik's APIs, please visit http://developer.wordnik.com.
Prerequisites
You need the following installed and available in your $PATH:
You also need to add the scala binary to your PATH.
To build the codegen library
This will create the swagger-codegen library in your build folder.
mvn package
To generate a sample client library
You can build a client against Wordnik's petstore API as follows:
./bin/scala-petstore.sh
This will run the script in src/main/scala/ScalaPetstoreCodegen.scala
and create the client. You can then
compile and run the client, as well as unit tests against it:
cd samples/petstore/scala mvn package
Do the same for java
by running ./bin/java-petstore.sh
Generating a client from flat files
If you don't want to call your server, you can save the swagger spec files into a directory and pass an argument to the code generator like this:
-DfileMap=/path/to/files Or for example: License ------- Copyright 2012 Wordnik, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.