intellij-swagger - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #golang #go #android #machine-learning #rust #java #cli #kubernetes #ios #openai #open-source

intellij-swagger

(★ 1,175)

A plugin to help you easily edit Swagger and OpenAPI specification files inside IntelliJ IDEA

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
- - build.yml
- dependabot.yml
- extensions-zalando.png
- features.gif
- - build.gradle
  - gradlew
  - gradlew.bat
  - README.md
  - settings.gradle
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.editorconfig
.env
.gitattributes
.gitignore
.zappr.yaml
build.gradle.kts
CODEOWNERS
gradlew
gradlew.bat
LICENSE
MAINTAINERS
README.md
release.sh
settings.gradle.kts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/zalando/intellij-swagger

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd intellij-swagger

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Plugin](https://github.com/zalando/intellij-swagger/actions/workflows/build.yml/badge.svg)](https://github.com/zalando/intellij-swagger/actions/workflows/build.yml)

# Zalando OpenAPI Editor
Zalando OpenAPI Editor makes it easy to edit OpenAPI and Swagger specification files inside IntelliJ IDEA. You can find it on JetBrains' [plugin page](https://plugins.jetbrains.com/plugin/8347).

![Zalando OpenAPI Editor features](https://github.com/zalando/intellij-swagger/blob/master/docs/features.gif?raw=true)

## Usage

Open an OpenAPI or Swagger specification file, that's it.

## Custom Extensions

You can extend the auto completion in order to provide custom keys and and values. The plugin provides the following extension points for this:

```xml
<extensionPoints>
    <extensionPoint qualifiedName="org.zalando.intellij.swagger.customFieldFactory" interface="org.zalando.intellij.swagger.extensions.completion.swagger.SwaggerCustomFieldCompletionFactory"/>
    <extensionPoint qualifiedName="org.zalando.intellij.swagger.customValueFactory" interface="org.zalando.intellij.swagger.extensions.completion.swagger.SwaggerCustomValueCompletionFactory"/>
</extensionPoints>
```

See the [Zalando extension example](https://github.com/zalando/intellij-swagger/blob/master/examples/extensions-zalando) for details.

## Development

Developing the Zalando OpenAPI Editor is easy, just execute the following command:

```./gradlew runIde```

This will start IntelliJ IDEA with the plugin installed.

## How to Contribute
To contribute, please fork and create a pull request.

### Bug Fixes
If you find a bug, it would be awesome if you created an issue about it. Please include a clear description of the problem so that we can fix it!

## License
The MIT License (MIT) Copyright © 2017 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.