OpenAPI 사양

OpenAPI Specification

이전에 스웨거 사양으로 알려진 OpenAPI 사양RESTful 서비스를 기술, 생산, 소비 및 시각화하기 위한 기계 판독이 가능한 인터페이스 파일의 사양이다.[1]이전에 스웨거 프레임워크의 일부였던 그것은 2016년에 오픈이 감독한 별도의 프로젝트가 되었다.리눅스 재단의 오픈 소스 협업 프로젝트인 API Initiative.[2]스웨거와 다른 도구들은 인터페이스 파일이 주어진 코드, 문서 및 테스트 케이스를 생성할 수 있다.

역사

스웨거 개발은 온라인 사전 회사 워드닉에서 일하던 토니 탐에 의해 2010년 초에 시작되었다.[3]킨 레인은 2014년 6월 12일 킨 레인(OpenAPI Operating Committee)과 토니 탐(Tony Tam)과의 밋업 토크를 마친 뒤 비슷한 접근법을 연구하고 있는 오웬 루벨에게 다가가 새로운 스웨거 2.0 스펙(결국 OpenAPI가 될 것)을 위한 아이디어를 빌렸다.[4][5]

스마트베어소프트웨어는 2015년 3월 워드닉의 모회사인 레버브 테크놀로지스로부터 오픈소스 스웨거 API 사양을 취득했다.[6]

2015년 11월 스마트베어는 오픈이라는 새로운 조직을 만들고 있다고 발표했다.리눅스 재단의 후원을 받는 API 이니셔티브.그 외 창업 회원사로는 3척, 에이피지, 캐피털원, 구글, IBM, 인튜이트, 마이크로소프트, 페이팔, 레스트렛 등이 있다.[7][8][9]SmartBear는 새 그룹에 스웨거 사양을 기증했다.RAMLAPI Blueprint도 그룹 차원에서 검토되고 있었다.[10][11]

2016년 1월 1일, 스웨거 사양은 OAS(OpenAPI 사양)로 이름이 바뀌었고, 새로운 GitHub 저장소로 이동되었다.[12]

2016년 9월, API World 컨퍼런스는 Swager에 대한 진행 중인 작업에 대해 SmartBear에게 API Infrastructure 상을 수여했다.[13]

2017년 7월 오픈API Initiative는 3.0.0 버전의 사양을 출시했다.[14]대체 RESTful API Modeling Language(RAML)의 주 기여자인 MuleSoft는 OAS에 가입해 RAML 입력에서 OAS 문서를 생성할 수 있는 API Modeling Framework 툴을 오픈소싱했다.[15]

2021년 2월 오픈API Initiative 버전 3.1.0.[16]주요 변경 OpenAPI 사양 3.1.0에는 JSON Schema 어휘 정렬, 대역 외에서 등록 및 관리되는 Webhook을 기술하는 새로운 최상위 요소, 표준 SPDX 식별자를 사용한 API 라이센스 식별 지원, PathItems 개체가 옵션으로 제공되어 구성요소의 재사용 가능한 라이브러리를 쉽게 만들 수 있다.ts.[17][18][19]

출시일

버전 날짜 노트[20]
3.1.0 2021-02-15 OpenAPI 사양 3.1.0 릴리스
3.0.3 2020-02-20 OpenAPI 사양 3.0.3의 패치 릴리스
3.0.2 2018-10-08 OpenAPI 사양 3.0.2의 패치 릴리스
3.0.1 2017-12-06 OpenAPI 사양 3.0.1의 패치 릴리스
3.0.0 2017-07-26 OpenAPI 사양 3.0.0 릴리스
2.0 2014-09-08 스웨거 2.0 해제
1.2 2014-03-14 공식 문서의 초기 릴리스
1.1 2012-08-22 스웨거 1.1 릴리스
1.0 2011-08-10 스웨거 사양 첫 번째 릴리스

사용법

개방형 환경을 기반으로 구현된 애플리케이션API 인터페이스 파일은 방법, 파라미터 및 모델의 설명서를 자동으로 생성할 수 있다.이것은 문서, 클라이언트 라이브러리 및 소스 코드를 동기화된 상태로 유지하는 데 도움이 된다.[21]

특징들

OpenAPI 사양은 언어에 구애받지 않는다.열기 포함API의 선언적 자원 사양, 클라이언트는 서버 구현이나 서버 코드에 대한 액세스에 대한 지식 없이도 서비스를 이해하고 소비할 수 있다.[21]

Open과 함께 작동하는 도구API

더 오픈API Initiative는 규격 3.0 버전에 대한 구현 목록을 유지 관리한다.SmartBear는 여전히 오픈 브랜드Swager 모니커를 사용하는 API 도구.스웨거 UI 프레임워크는 개발자와 비개발자 모두가 샌드박스 UI에서 API와 상호작용을 할 수 있도록 해 API가 파라미터와 옵션에 어떻게 대응하는지 통찰할 수 있게 해준다.스웨거는 JSONXML을 모두 다룰 수 있다.[21]

Swager Codegen에는 Open을 구문 분석하여 문서, API 클라이언트 및 서버 스텁을 다른 언어로 생성하기 위한 템플릿 기반 엔진이 포함되어 있음API 정의.2018년 7월, 스웨거 코드겐의 일등 공신인 윌리엄 쳉과 다른 40명 이상의 스웨거 코드겐의 일등 공신들이 이 코드를 오픈이라는 이름의 프로젝트로 바꾸었다.OpenAPI [22]Tools 조직의 API 생성기[23]

연례 회의

더 오픈API Initiative는 매년 API 사양 컨퍼런스(ASC)를 후원한다.이 행사는 수년 동안 진행되어 오픈에 참가하게 된 API 전략 및 실무 회의(APIStrat)에서 유래가 있다.2016년 API 이니셔티브.

참고 항목

참조

  1. ^ "Linux Foundation wants to extend Swagger in connected buildings Business Cloud News". Archived from the original on 6 May 2016. Retrieved 22 April 2016.
  2. ^ "OpenAPI Initiative Charter". OpenAPI Initiative. Retrieved 12 November 2019.
  3. ^ "Swagger creator joins SmartBear". Retrieved 6 August 2019.
  4. ^ "API Design Panel". Retrieved 6 August 2019.
  5. ^ "Kin Lane Confesses To Borrowing OpenAPI ideas from separate project". Retrieved 6 August 2019.
  6. ^ "SmartBear Assumes Sponsorship of Swagger API Open Source Project". SmartBear. Retrieved 25 March 2015.
  7. ^ "FAQ". OpenAPI Initiative. Retrieved 12 November 2019.
  8. ^ "SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger". ProgrammableWeb. 10 November 2015. Retrieved 21 April 2016.
  9. ^ "New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services". www.linuxfoundation.org. Archived from the original on 27 April 2016. Retrieved 22 April 2016.
  10. ^ Montcheuil, Yves de. "In 2016, the need for an API meta-language will crystallize". InfoWorld. Retrieved 25 April 2016.
  11. ^ "Amazon API Gateway Now Supports Swagger Definition Import". InfoQ. Retrieved 25 April 2016.
  12. ^ OpenAPI Initiative. "OpenAPI Specification". GitHub. Retrieved 12 November 2019.
  13. ^ "Swagger wins the 2016 API Award for API Infrastructure". Swagger Blog. Retrieved 27 July 2018.
  14. ^ "The OAI Announces the OpenAPI Specification 3.0.0". OpenAPIs. Retrieved 19 April 2018.
  15. ^ "The HTTP API space is Consolidating around OAS". InfoQ. Retrieved 14 May 2017.
  16. ^ "OpenAPI Specification 3.1.0 Available Now". Linux.com. Retrieved 26 April 2021.
  17. ^ "What's New in OpenAPI 3.1.0?". Nordic APIs. Retrieved 7 April 2021.
  18. ^ "OpenAPI Specification 3.1.0 Released". OpenAPI Initiative. Retrieved 18 February 2021.
  19. ^ "Migrating from OpenAPI 3.0 to 3.1.0". OpenAPI Initiative. Retrieved 16 February 2021.
  20. ^ [b "OpenAPI Specification Version 3.0.4"]. Retrieved 23 April 2020. {{cite web}}:수표 url=가치(도움말)
  21. ^ a b c "swagger-api/swagger-spec". GitHub. Retrieved 1 December 2015.
  22. ^ "Swagger Codegen is now OpenAPI Generator". Retrieved 6 August 2019.
  23. ^ "Swagger Codegen Fork: Q&A". Retrieved 6 August 2019.

참고 문헌 목록

외부 링크