CLion 2020.2 Help

OpenAPI

An OpenAPI Specification (OAS) is a description format for REST APIs. Swagger is a set of tools based on this specification for writing, documenting, and consuming REST APIs. For more information, see Swagger documentation.

CLion provides coding assistance for OpenAPI definitions in YAML and JSON files, and integration with Swagger Codegen for generating server stubs, client libraries (SDKs), and documentation based on your OpenAPI specification.

Create an OpenAPI specification

CLion recognizes a dedicated OpenAPI Specification file type with relevant coding assistance. These are regular YAML or JSON files with the definition of the OpenAPI specification version.

  1. In Project view, select New | OpenAPI Specification from the context menu.

  2. Specify a name for the file and select the specification version and file format.

Depending on the format and version, the new OpenAPI specification file contains the following template:

openapi: 3.0.0 info: title: Title description: Title version: 1.0.0 servers: - url: 'https' paths:
{ "openapi": "3.0.0", "info": { "title": "Title", "description": "Title", "version": "1.0.0" }, "servers": [ { "url": "https" } ], "paths": { } }
swagger: "2.0" info: title: Title description: Title version: 1.0.0 host: www schemes: - https paths:
{ "swagger": "2.0", "info": { "title": "Title", "description": "Title", "version": "1.0.0" }, "host": "www", "schemes": [ "https" ], "paths": { } }

If you start with an empty YAML or JSON file, you can type the opnp or swag live template and press Tab to insert the corresponding template text.

URLs that you define in OpenAPI specifications in your project are available for code completion. If you are writing client code for an external specification, there is no need to add it as a file to your project for auto-completing URLs. You can add a link to the relevant remote specification.

Add a remote OpenAPI specification

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | OpenAPI Specification.

  2. Click the Add button and specify the URL of the OpenAPI specification file.

The OpenAPI Specification settings

Use The Reload All Specifications button to reload specifications that were modified.

Compare OpenAPI specifications

When there is a newer specification version, you probably want to compare it against the older version to make sure that they are compatible. One way is to look at the diff Ctrl+D and compare lines that changed. However, not all changes are critical for compatibility. CLion can compare the structure of OpenAPI specifications and create a summary of changed paths, parameters, responses, and any other elements that may break the compatibility.

  • In the Project tool window, select two OpenAPI specification files, right-click them and select Compare OpenAPI Specifications.

This generates a Markdown file with a summary of modified specification elements. The file opens in the editor with a preview panel that makes it easy to navigate the changes. It shows the changes in the file that you selected second compared to the first one.

Generate code from an OpenAPI specification

When you have a valid OpenAPI specification open, CLion suggests to generate code from it:

Generate code based on the OpenAPI specification

Click Run Codegen, configure the necessary settings, then apply the changes and run the configuration. CLion generates source code files in the specified location and shows a notification with options to open the files or import them into your project as a separate module.

Swagger Codegen run configuration

CLion creates a Swagger Codegen run configuration, which you can configure when you run code generation for the first time for a particular file. To modify the run configuration, open Run | Edit Configurations and select the necessary configuration, or click Edit Generation Settingsthe Edit Generation Settings button at the top of the editor when the corresponding OpenAPI specification file is open.

You can configure the following common options at the top of the Swagger Codegen run configuration:

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, CLion suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and CLion stores run configuration settings in .idea/workspace.xml.

General Settings

Item

Description

Specification pathPath to the OpenAPI specification.
Generate files toPath to the directory for the generated files.
Generator path Path to the generator (the executable JAR file). You can either manually specify the path to a local generator or select to use the latest available version from Maven Central.
LanguageThe target language of the generated code.
Configure generator

Provide configuration parameters that depend on the target language.

  • With .json file: Specify the path to config.json with configuration parameters.

  • With properties: Specify parameters manually.

For information about the configuration parameters, see the swagger-codegen/README.md.

Advanced Settings

Item

Description

Custom templates pathPath to a directory with your Mustache templates.
JREJava runtime to use for running Swagger Codegen.
Show debug logsWrite debug messages to the log.

Before launch

Add tasks to perform before starting the run configuration in the specified order. For example, you can run another configuration or an external tool first.

Item

Description

Show this pageShow this run configuration settings dialog before starting it.
Activate tool window Open the Run tool window when this configuration starts. If this is disabled, to open the tool window, select View | Tool Windows | Run Alt+4.
Last modified: 14 September 2020