Open API 와 OpenAPI 란?

📚 알쓸코잡 : 알아두면 쓸모있는 코딩 잡학지식!

1️⃣ 서론

개발을 하면서 Open API 라는 용어를 많이 접하게 됩니다. 최근에 비슷하지만 다른 의미를 갖는 OpenAPI 라는 용어를 알게 되었는데요. 이번글에서는 이 둘의 차이점이 무엇인지를 이야기 해볼까 합니다.

2️⃣ Open API 와 OpenAPI ?

(1) Open API

Open API 는 단어의미 그대로 개발자라면 누구나 사용할 수 있도록 공개된 API를 말합니다. 대표적인 예시로 우편번호 API 나 공공API 포털에서 제공하는 것들이 있습니다.

(2) OpenAPI

반면에 Open API 와 띄어쓰기 한개(“ “) 밖에 차이가 나지 않는 OpenAPI 는 무슨뜻일까요?

OpenAPI 는 “OpenAPI Specification”의 약자로 OAS 라고도 불리며, API 설계와 문서화를 위한 오픈 표준 형식을 의미합니다. OpenAPI 는 RESTful API를 문서화하고 정의하기 위한 명세(Specification)를 작성하는 데 사용되며, 이 명세는 API의 엔드포인트, 매개변수, 요청과 응답 형식, 보안 설정 등을 세부적으로 기술합니다.

(3) OpenAPI Initiative (OAI)

번외로 OpenAPI를 관리하는 단체도 있는데요, 그곳이 바로 OpenAPI Initiative 입니다.

OpenAPI Initiative 는 Linux Foundation에 의해 주도되는 공개 표준 프로젝트로서, 다양한 업체와 개발자 커뮤니티가 참여하여 API 설계와 문서화를 위한 표준 형식인 OpenAPI Specification을 개발하고 유지보수하는 역할을 합니다.

3️⃣ TMI

🤔 OpenAPI 와 Swagger 는 어떤 관계일까요?

OpenAPI는 Swagger Specification 이라고도 알려져 있는데요, OpenAPI 와 Swagger 는 어떤 관계일까요?

사실 Swagger는 OpenAPI Specification의 이전 이름이었습니다. Swagger는 2011년에 Wordnik에서 개발되었으며, RESTful API를 설계, 문서화 및 테스트하기 위한 오픈 소스 도구로서 널리 사용되었습니다.

그러나 2015년에 Swagger는 SmartBear Software의 협력으로 OpenAPI Initiative (OAI) 에 기여하게 되었으며, 이때 기존의 Swagger 기반으로 만들어진것이 OpenAPI Specification 입니다.

즉, 어떻게보면 OpenAPI Specification은 Swagger Specification의 후속 버전이라고도 볼 수 있겠습니다.