Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.26 KB

README.md

File metadata and controls

41 lines (28 loc) · 2.26 KB

openapi-processor-intellij

Build Version Downloads

Plugin Description

Adds support for the openapi-processor mapping.yaml configuration file.

  • automatically selects the json schema of the mapping.yaml to provide editing support (autocompletion & validation). Note that the openapi-processor-mapping: v[x] line in the mapping.yaml is used to detect it.
  • marks the mapping.yaml with an openapi-processor icon to separate it from the openapi yaml file(s) (includes new ui icon)
  • navigate from the package-name configuration in the mapping.yaml to the package with the generated sources (if the target package exists).
  • navigate from an endpoint path mapping in the mapping.yaml to the generated interface method (via a standard interface icon).
  • navigate from an OpenAPI endpoint path to the generated endpoint interface methods (via a standard interface icon).
  • navigate from a generated endpoint interface to the OpenAPI endpoint path (via a standard OpenAPI icon).

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "openapi-processor-intellij" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Logging

  • to enable debug logging add "io.openapiprocessor.intellij:trace" into Help/Diagnostic Tools/Debug Log Settings...

Plugin based on the IntelliJ Platform Plugin Template.