Swagger
The Workiva Developer API is specified using Swagger.
Generating client libraries using swagger-codegen
If you’d like to leverage a client library to talk to the Workiva Developer API,
you can use the
swagger-codegen project.
Client libraries can be generated for more than 25 languages.
To generate a client library for the language of your choice, install and use swagger-codegen. You can install swagger-codegen with wget or Homebrew.
wget http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.1/swagger-codegen-cli-2.2.1.jar -O swagger-codegen-cli.jar
or on macOS,
brew install swagger-codegen
Now, to generate client code for the language of your choice, for example,
Java, here is an example usage of the code generator:
swagger-codegen generate -i swagger.json -l java -o /tmp/test/
The preceding command will output the generated client code to
/tmp/test
.
Using generated client code is language specific. Consult the README and usage
examples of the generated code.