Auto-Generate Ruby API Client (Faraday) for REST APIs

1 point

7 years ago

We've added Faraday support to OpenAPI Generator (https://github.com/OpenAPITools/openapi-generator). To generate the Ruby API client (Faraday as opposed to Typhoeus) given an OpenAPI/Swagger specification file, please follow 3 simple steps below:

1. Download the Java JAR (https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/4.1.0-SNAPSHOT/openapi-generator-cli-4.1.0-20190806.012415-118.jar)

2. Rename the JAR as "openapi-generator-cli.jar"

3. Run the following command to generate a Ruby API client for the Petstore API (https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml):

Mac/Linux:

$ java -jar openapi-generator-cli.jar generate -g ruby -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml -o /var/tmp/ruby/ --additional-properties library=faraday

Windows:

$ java -jar openapi-generator-cli.jar generate -g ruby -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml -o C:\tmp\ruby --additional-properties library=faraday

If you've any feedback or question, please let us know via https://github.com/OpenAPITools/openapi-generator/issues/new