An open API service indexing awesome lists of open source software.

https://github.com/openapi-processor/openapi-processor-intellij

IntelliJ plugin - provides support for openapi-processor configuration file
https://github.com/openapi-processor/openapi-processor-intellij

Last synced: 9 days ago
JSON representation

IntelliJ plugin - provides support for openapi-processor configuration file

Awesome Lists containing this project

README

          

# openapi-processor-intellij

[![Build](https://github.com/openapi-processor/openapi-processor-intellij/actions/workflows/build.yml/badge.svg)](https://github.com/openapi-processor/openapi-processor-intellij/actions/workflows/build.yml)
[![Version](https://img.shields.io/jetbrains/plugin/v/17008.svg)](https://plugins.jetbrains.com/plugin/17008)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/17008.svg)](https://plugins.jetbrains.com/plugin/17008)

## Plugin Description

Adds support for the [openapi-processor](https://openapiprocessor.io/oap/home/home.html) `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|spring]: 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" >
Install Plugin

- Manually:

Download the [latest release](https://github.com/openapi-processor/openapi-processor-intellij/releases/latest) 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][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template