Zalando's architecture centers around microservices, and each API is documented with an OpenAPI specification. Zalando has its own API Guidelines that extends the standard OpenAPI specification. This extension example illustrates how the Zalando OpenAPI Editor can be extended to support Zalando specific guidelines for REST APIs.

To start IntelliJ IDEA with the plugin installed:

./gradlew runIde

To verify the plugin against different IDEA versions run:

./gradlew runPluginVerifier

This will output information of compatibility and also create reports under ./build/reports/pluginVerifier/.

Generic verification:

./gradlew check

See ./release.sh

Check dependency updates (preferably replaced with Dependabot):

./gradlew dependencyUpdates

The MIT License (MIT) Copyright © 2018 Zalando SE, https://tech.zalando.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.