API Discovery

API Discovery에 대해 설명합니다.

히스토리 GitLab 15.9에서 도입 됨. API Discovery 기능은 베타 단계입니다. API Discovery는 애플리케이션을 분석하여 노출하는 웹 API를 설명하는 OpenAPI 문서를 생성합니다. 이 스키마 문서는 API 보안 테스팅 분석기 또는 API 퍼징 이 웹 API의 보안 스캔을 수행하는 데 사용할 수 있습니다. 지원되는 프레임워크 # Java Spring-Boot API Discovery는 언제 실행되나요? # API Discovery는 파이프라인에서 독립적인 job으로 실행됩니다. 결과 OpenAPI 문서는 이후 단계의 다른 job에서 사용할 수 있도록 job 아티팩트로 캡처됩니다. API Discovery는 기본적으로 test 단계에서 실행됩니다. test 단계는 API 보안 테스팅 및 API 퍼징과 같은 다른 보안 기능에서 사용하는 단계보다 일반적으로 먼저 실행되기 때문에 선택되었습니다. API Discovery 구성 예시 # 다음 프로젝트는 API Discovery를 보여줍니다: Java Spring Boot v2 Pet Store 예시 Java Spring-Boot # Spring Boot 는 독립형 프로덕션 급 Spring 기반 애플리케이션을 만들기 위한 인기 있는 프레임워크입니다. 지원되는 애플리케이션 # Spring Boot: v2.X (>= 2.1) Java: 11, 17 (LTS 버전) 실행 가능한 JAR API Discovery는 Spring Boot 주요 버전 2, 부 버전 1 이상을 지원합니다. 버전 2.0.X는 API Discovery에 영향을 미치며 2.1에서 수정된 알려진 버그로 인해 지원되지 않습니다. 주요 버전 3은 향후 지원될 예정입니다. 주요 버전 1에 대한 지원은 계획되어 있지 않습니다. API Discovery는 Java 런타임의 LTS 버전으로 테스트되고 공식적으로 지원됩니다. 다른 버전도 작동할 수 있으며 비-LTS 버전의 버그 보고서는 환영합니다. Spring Boot 실행 가능한 JAR 으로 빌드된 애플리케이션만 지원됩니다. 파이프라인 job으로 구성 # API Discovery를 실행하는 가장 쉬운 방법은 CI 템플릿을 기반으로 한 파이프라인 job을 통해서입니다. 이 방법으로 실행할 때 필요한 종속성이 설치된 컨테이너 이미지(적절한 Java 런타임 등)를 제공합니다. 자세한 내용은 이미지 요구 사항 을 참조하세요. 이미지 요구 사항 을 충족하는 컨테이너 이미지가 컨테이너 레지스트리에 업로드됩니다. 컨테이너 레지스트리에 인증이 필요한 경우 이 도움말 섹션 을 참조하세요. build 단계의 job에서 애플리케이션을 빌드하고 결과 Spring Boot 실행 가능 JAR을 job 아티팩트로 구성합니다. .gitlab-ci.yml 파일에 API Discovery 템플릿을 포함합니다. include: - template: Security/API-Discovery.gitlab-ci.yml .gitlab-ci.yml 파일당 하나의 include 문만 허용됩니다. 다른 파일을 포함하