OpenAPI Specification
OAS 3.1.1 Released!
OpenAPI 사양은 Linux Foundation 공동 프로젝트 인 OpenAPI 이니셔티브 내에서 커뮤니티 중심의 공개 사양입니다.
OpenAPI 사양 (OAS)은 HTTP API에 대한 표준 프로그래밍 언어-비수기 인터페이스 설명을 정의합니다. 이를 통해 인간과 컴퓨터는 소스 코드, 추가 문서 또는 네트워크 트래픽 검사에 대한 액세스없이 서비스 기능을 발견하고 이해할 수 있습니다. OpenAPI를 통해 올바르게 정의하면 소비자는 최소한의 구현 로직으로 원격 서비스를 이해하고 상호 작용할 수 있습니다. 하위 레벨 프로그래밍을 위해 인터페이스 설명이 수행 한 것과 유사하게 OpenAPI 사양은 서비스 호출의 추측을 제거합니다.
기계로 읽을 수있는 API 정의 문서의 사용 사례에는 다음이 포함되지만 이에 국한되지는 않습니다. 대화식 문서; 문서, 클라이언트 및 서버를위한 코드 생성; 및 테스트 사례의 자동화. OpenApi 문서는 API 서비스를 설명하며 Yaml 또는 JSON 형식으로 표시됩니다. 이 문서는 응용 프로그램에서 동적으로 정적으로 생성되고 동적으로 생성 될 수 있습니다.
OpenAPI 사양은 기존 API를 다시 작성할 필요가 없습니다. 소프트웨어를 서비스에 바인딩 할 필요는 없습니다. 설명 된 서비스는 설명의 제작자가 소유하지 않을 수도 있습니다. 그러나 서비스 기능은 OpenAPI 사양의 구조에 설명되어야합니다. 모든 서비스가 OpenAPI에서 설명 할 수있는 것은 아닙니다.이 사양은 가능한 모든 스타일의 HTTP API를 다루기위한 것이 아니라 REST API에 대한 지원을 포함합니다. OpenAPI 사양은 설계 우선 또는 코드 우선과 같은 특정 개발 프로세스를 의무화하지 않습니다. HTTP API와의 명확한 상호 작용을 확립함으로써 두 기술을 촉진합니다.
이 GitHub 프로젝트는 OpenAPI의 시작점입니다. 여기에서는 OpenAPI 사양에 필요한 정보, 모습에 대한 간단한 예제 및 프로젝트에 관한 일반적인 정보를 찾을 수 있습니다.
이 저장소에는 게시 된 모든 OpenApi 사양 버전의 Markdown 소스가 포함되어 있습니다. 릴리스 노트 및 릴리스 후보 버전은 릴리스 페이지를 참조하십시오.
스키마 및 테스트와 같은이 저장소의 각 폴더에는 사양의 현재 및 이전 버전과 관련된 폴더가 포함되어야합니다.
그것이 작동하는 것을보고 싶다면 현재 예제 목록을 확인하십시오.
자신의 OpenApi 정의를 만들거나 제시하거나 사용하는 방법을보고 싶으십니까? 점점 늘어나는 구현 목록을 확인하십시오.
OpenAPI 사양을 개발하기위한 현재 프로세스는 기여 지침에 설명되어 있습니다.
다음 버전의 OpenAPI 사양을 개발하는 것은 기술 운영위원회 (TSC)에 의해 안내됩니다. 이 Committers 그룹은 API 전문 지식을 제공하고 커뮤니티의 피드백을 통합하며 커밋터 그룹을 적절하게 확장합니다. 향후 사양에 대한 모든 개발 활동은 기능으로 수행 되며이 지점으로 병합됩니다. 향후 사양이 출시되면이 지점은 main 으로 합병됩니다.
TSC는 주간 웹 컨퍼런스를 개최하여 Open Pull 요청을 검토하고 진화하는 OpenAPI 사양과 관련된 공개 문제를 논의합니다. 주간 전화 및 예정된 작업 세션에 참여하는 것은 커뮤니티에 공개됩니다. OpenAPI 기술 회의 전체를 온라인으로 볼 수 있습니다.
OpenApi 이니셔티브는 개인 및 회사 모두의 참여를 장려합니다. OpenAPI 사양의 진화에 참여하려면 다음 조치를 취하십시오.
모든 피드백을 수용 할 수있는 것은 아니며 사양에 적합한 변경에 대한 확실한 주장이있을 수 있습니다.
참조 : 라이센스 (Apache-2.0)
