intellij-swaggerhub-release: Issue Tracker

SwaggerHub extension for Intellij lets you view and edit OpenAPI definitions stored in SwaggerHub directly from Intellij.

In this repository, you can:

:grey_question: Ask questions about the extension
:bug: Report bugs
:bulb: Suggest new features or enhancements
:+1: Upvote existing requests
:memo: Submit general feedback

Please search existing issues before opening a new one.

Minimum IntelliJ version requirement - 2020.3

Plugin Features

• View and navigate definitions from your SwaggerHub organizations.
• Edit and save definitions to SwaggerHub.
• Create new APIs and domains from scratch or using a template.
• Create new versions of your APIs and domains.
• Preview your APIs in Swagger UI.
• Delete definitions by the version or the entire definition.
• Validate your definitions against the OpenAPI 3.0 and 2.0 schemas.
• Add API mocks for quick definition testing

Plugin Configuration

After downloading the zip file from the release page, please follow install from disk instructions.

Before using the SwaggerHub extension, you need to configure its settings, after installation you will see the below panel

Clicking the "Add First Organization" you will see the below modal

• On-Prem address: If you use SwaggerHub On-Premise, change the value to http(s)://YOUR_SERVER/v1. SwaggerHub SaaS users should leave the default value, https://api.swaggerhub.com.
• Api Key: Specify your SwaggerHub API key found at https://app.swaggerhub.com/settings/apiKey or at http(s)://YOUR_SERVER/settings/apiKey if you use SwaggerHub On-Premise.
• User's organizations: Add a list of SwaggerHub organizations that you want to access

Resources

• SwaggerHub documentation: Learn more about SwaggerHub
• OpenAPI syntax guide: Learn how to write OpenAPI definitions

If you need help with SwaggerHub itself (not the Intellij extension), contact Support.