[API] 스웨거(Swagger)와 오픈API 란?

 

스웨거(Swagger)와 오픈API 란?

 

 

---

Contents.

 

1. OpenAPI란 무엇인가? 

2. 스웨거란?

 

---

 

 

API 연동기획업무를 하게 되었다.

새로운 플랫폼의 한 서비스에서의 
API 연동기획 담당자가 되었는데,
처음부터 필요한 직무지식을 쌓아야하는 상황이다.

오늘부터 올릴 포스팅 시리즈는
API 연동 기획업무의 학습과정이다.
이 업무의 숙련자가 되는 과정을 기록해보도록 하겠다.

API를 기획하는 업무의 첫시작은 Swagger(스웨거)
에 대해 잘 알아야하는 것 부터였다.

 

---

OpenAPI란 무엇인가?

 

오픈 API에 대해서 알기 전에, 
API가 무엇인지에 대해 정리해보겠다.
API란 Application Programming Interface.
응용 프로그램에서 사용할 수 있도록, 
운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게
만든 인터페이스를 뜻한다.

이런 인터페이스를 공개하여 타 시스템과의 연계하는데 사용하는 것을
오픈 API라고 생각하면 된다. 스웨거는 이 오픈 API를 문서화하는 도구로 보면 된다.

 

 

 

 

---

스웨거란?

스웨거는 오픈 API 명세를 위한 프레임워크다.
API들이 가지고 있는 정보들을 명세, 관리할 수 있는 도구인데,
API 문서화하는 작업을 시스템화하는 툴이라고 볼수 있다. 
정리해보자면, 스웨거는 오픈 API 명세를 중심으로 만들어진 오픈소스 툴로 
REST API들을 설계, 구축, 문서화할 수 있다.

내가 사용하게 될 솔루션은
이 스웨거를 사용하여 json파일 또는 yaml파일을 만든 후, 업로드하여 사용한다.
시스템에서 사용하게 될 API들을 연계되는 타 회사들이 확인할 수 있도록
등록 및 관리를 한다.

솔루션에 등록하는 API들을 만들기 위해서는

일단 yaml파일을 스웨거로 사용하여 만들어야 한다.
다음은 스웨거의 기본구조를 yaml파일로 만들어보자.