Tooling

What tools to use to generate client libraries

  less than a minute  

While it is possible to use the API using standard HTTP clients, there are a variety of tools available online can be used to generate client libraries for many programming languages.

Steps, using C# as an example

  1. Download the specification file. It is in OpenAPI 3 format, and can be downloaded here.
  2. On a web browser, go to the swagger editor.
  3. In the Swagger Editor, go to File->Import File, and select the downloaded json file.
  4. Once the json is imported, go to Generate Client, and select “csharp”.
  5. Download and extract the client package.

This will produce a client package, containing:

  • README.md: outlines build requirements, installation, and sample usage
  • src: project of the generated C# classes
  • docs: markdown documentation generated from Swagger specification

For more information on Swagger Codegen, including how to obtain and use the command-line version of the tool, visit https://github.com/swagger-api/swagger-codegen