https://github.com/jimschubert/intellij-openapi-generator

Intellij Plugin for openapi-generator
https://github.com/jimschubert/intellij-openapi-generator

hacktoberfest intellij-plugin openapi openapi-generator openapi3 sdk

Last synced: 3 months ago
JSON representation

Intellij Plugin for openapi-generator

• Host: GitHub
• URL: https://github.com/jimschubert/intellij-openapi-generator
• Owner: jimschubert
• License: apache-2.0
• Created: 2016-06-15T03:38:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-02T02:27:59.000Z (over 4 years ago)
• Last Synced: 2024-05-02T05:37:04.096Z (9 months ago)
• Topics: hacktoberfest, intellij-plugin, openapi, openapi-generator, openapi3, sdk
• Language: Kotlin
• Homepage: https://openapi-generator.tech/
• Size: 493 KB
• Stars: 76
• Watchers: 5
• Forks: 12
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAPI Generator plugin for IntelliJ IDEs

![Assemble Plugin](https://github.com/jimschubert/intellij-openapi-generator/workflows/Assemble%20Plugin/badge.svg)

The OpenAPI Generator plugin allows you to generate client, server, or documentation code from your OpenAPI specifications within your IDE.

This plugin allows for a sort of _spec_ driven development.

While designing your API, you can generate one or more clients from within the IDE to evaluate your changes.

Also install [intellij-swagger](https://plugins.jetbrains.com/plugin/8347) for a seamless Swagger/OpenAPI editor experience.

# Building

```

./gradlew clean buildPlugin

```

# Running in IntelliJ

First, you'll need to [setup a development environment](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/setting_up_environment.html).

Then:

```

./gradlew runIde

```

NOTE: When running locally, if changes don't appear in the sandbox instance you may have forgotten to update the plugin version in `gradle.properties`.

# Usage

Open a Specification YAML or JSON file in IntelliJ. Supported specifications are: OpenAPI 2.0/OpenAPI 3.0. With the document active, navigate to Code -> OpenAPI -> Generate from Document.

Choose your desired generator and fill out options. Then, choose an output directory and generate.

## License

This project is licensed under the Apache 2.0 license. See [./LICENSE](LICENSE) for more details.

Swagger® is a registered trademark of SmartBear Software, Inc.

This project is not maintained by, or associated with, SmartBear Software, Inc.

This project is not maintained by, or associated with, OpenAPI Initiative (OAI) in anyway.