[웹 지식] OpenAPI vs Open API

제목만 봐서는 뭔 소리인지 싶을 것이다...

근데 진짜 저 띄어쓰기 하나로 의미가 아예 달라진다

 

 

ㅁOpenAPI: API 명세 표준(OpenAPI Specification)

OpenAPI는 RESTful API를 기술하기 위한 표준 포맷(Specification)이다.
예전에는 Swagger Specification이라고 불렸고, 현재는 OpenAPI Initiative라는 비영리 단체에서 관리한다.

 

주요 특징

• JSON or YAML 형식으로 API의 경로, 요청/응답, 인증 방식 등을 정의할 수 있다
• 사람이 읽기 쉽고, 동시에 기계가 이해할 수 있도록 설계되어 있다
• 문서화 자동화, API 테스트 자동화, 클라이언트/서버 코드 생성 등 다양한 도구와 연계된다

YAML 형식의 OpenAPI 문서

 

 

대표 도구

• Swagger UI
• Swagger Editor
• Redoc
• Postman(OpenAPI 지원)
• Stoplight

(참고) Spring REST Docs는 OpenAPI 기반은 아니지만, 테스트 기반으로 API 문서를 자동 생성하는 방식으로 많이 사용된다

 

따라서 OpenAPI는 API 자체가 아니라, API를 정의하기 위한 표준 명세(Specification)이다

---

 

ㅁOpen API: 개방형 API (Public API)

 

Open API는 누구나 사용할 수 있도록 공개된 API를 뜻한다.
개발자 등록만 하면 키를 발급받아 사용할 수 있는 공공 데이터 API, SaaS 플랫폼 API 등이 여기에 해당한다.

 

https://claremont.tistory.com/entry/%EC%9B%B9-%EA%B0%9C%EB%B0%9C-%EA%B8%B0%EC%83%81%EC%B2%AD-API-%ED%99%9C%EC%9A%A9-Python-%EC%BD%94%EB%93%9C

[웹 개발] 기상청 API 활용 Python 코드

 

주요 특징

• 인증 방식은 있지만, 회원가입만 하면 누구나 접근 가능
• 기업 또는 기관이 외부 개발자와의 연동을 위해 제공
• API 사용 범위, 호출 수 제한 등의 조건이 붙을 수 있음

예시

• 공공데이터 포털 API (e.g. 기상청 날씨 API, 교통정보 API)
• 네이버, 카카오의 지도/번역/검색 API
• Twitter API, YouTube Data API 등

 

Open API는 누구에게나 열려 있는 API 서비스 그 자체를 말한다.