ReadMe_Korean.md

Swaggy Swagger

English | 한국어

개요

Swaggy-Swagger 는 인기 있는 API 문서화 도구인 Swagger의 기능과 사용자 경험을 향상시키기 위해 설계된 라이브러리입니다.

자세한 정보는 Swaggy-Swagger README.md 를 참고해주세요.

시연 영상

요구사항

• 자바 17 이상: 이 프로젝트는 자바17 이상의 버전이 필요합니다.
• 스프링 부트 3.x: 호환성을 위해 스프링 부트 3 이상의 버전을 사용하는지 확인해주세요.
• 스웨거 의존성 2.x: springdoc-openapi 2 이상의 버전을 의존성에 포함해야 정상적으로 동작합니다.

설치

프로젝트에 dependency 추가하기

repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.Swaggy-Swagger:swagger-custom-java:1.0.1'
}

버젼 정보

Swaggy-Swagger 버젼	배포일	배포 노트
1.0.1	2024-11-13	tag 1.0.1

반드시 1.0.1 이상의 버전을 사용하세요. 1.0.0 및 0.0.1 버전은 알려진 문제가 있으니 사용하지 않기를 권장합니다.

기능 추가하는 방법

코드 작성 순서대로 API 정렬하는 기능

import io.swaggy.swagger.customlib.config.SwaggyConfig;
import io.swaggy.swagger.customlib.utils.OpenApiChangeTracker;
import org.springdoc.core.customizers.OpenApiCustomizer;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

// 사용자의 OpenApi 설정 클래스에 'SwaggyConfig' 클래스를 추가해주세요.
@Configuration
@Import(SwaggyConfig.class)
public class YourOpenApiConfig {
}

API Tag로 컨트롤러 정렬하는 기능

위에서 언급된 SwaggyConfig.class 가 프로젝트에 적용되어 있어야 합니다.

# application.yml 
swaggy:
  tags:
    - "tagName1"
    - "tagName2"
    - "tagName3"
    ...

예시

application.yml	Result

API 변경 사항 추적하고 저장하는 기능

import io.swaggy.swagger.customlib.utils.OpenApiChangeTracker;
import org.springdoc.core.customizers.OpenApiCustomizer;
import org.springframework.context.annotation.Configuration;

@Configuration
public class YourOpenApiConfig {
    
    // 사용자의 OpenApi 설정 클래스에 'OpenApiCustomizer' Bean을 등록해주세요.
    @Bean
    public OpenApiCustomizer openApiCustomizer() {
        return new OpenApiChangeTracker();
    }
}

컨트리뷰트 하는 방법

모든 컨트리뷰트를 환영합니다!

• 프론트엔드(UI)에 컨트리뷰트하고 싶으시다면, 더 자세한 정보는 swaggy-ui를 확인해주세요.

• 현재 레포지토리인, 백엔드(서버 사이드)에 컨트리뷰트하고 싶으시다면, CONTRIBUTING.md를 참고해주세요.

컨트리뷰터

Swaggy-Swagger에 기여해주신 모든 분들께 감사드립니다.

Made with contrib.rocks

라이센스

Swaggy-Swagger는 Apache License 2.0 버전 라이센스 하에 있습니다. 더 자세한 정보는 LICENSE에서 확인해주세요.

연락처