Generate a Client SDK library for Management API

Owned by Antti Kallio
Last updated: 01 Apr 2021 by Kari Mattsson
2 min read

You can generate a client SDK for the Management API with any OpenAPI based code generator. By generating the client yourself, you have more control over dependencies and updates.

OpenAPI documentation

The OpenAPI document for Management API is downloadable from:

https://<ID_SERVER_DOMAIN>/api/rest/v1/openapi.json

SwaggerHub

SwaggerHub is a web based OpenAPI document editor and code generator.

You can import the OpenAPI document into SwaggerHub and generate a client from there. SwaggerHub is simple to use but does not support all the languages, libraries and options that Codegen supports, so you might want to look into it next.

Swagger Codegen

Swagger Codegen is a Java based code generator. You can run it from the command line as a CLI application, or through Maven. It supports a large amount of languages and has a large amount of customisation options.

java -jar swagger-codegen-cli.jar generate \ -i openapi.json \ -o apiclient \ -l java

OpenAPI Generator

OpenAPI Generator is similar to Swagger Codegen. Most of the options are identical. It supports a slightly different set of languages and libraries, and generates slightly different style of code.

java -jar openapi-generator-cli.jar generate \ -i openapi.json \ -o apiclient \ -g java \ --skip-validate-spec