Swagger 이란? | ChatGPT

Swagger 

Swagger는 API 문서를 자동으로 생성하고 관리하기 위한 강력한 도구 및 프레임워크입니다. Swagger를 사용하면 개발자들이 API를 쉽게 이해하고 사용할 수 있도록 API 문서를 생성하고 표시하는 데 도움이 됩니다. Swagger를 통해 API의 엔드포인트, 매개변수, 요청 및 응답 형식, 인증 설정 등을 문서화할 수 있습니다.

---

🔵 Swagger를 사용하는 주요 단계와 컴포넌트

🔴 Swagger 스펙 정의 (Swagger Specification)

Swagger는 API 문서를 생성하기 위한 스펙을 제공합니다. 이 스펙은 OpenAPI 스펙이라고도 불리며, API를 설명하는 데 필요한 정보를 정의합니다. 이 정보는 JSON 또는 YAML 형식으로 작성됩니다.

🔴 Swagger 도구 또는 미들웨어 사용

Swagger를 사용하기 위해 다양한 도구와 미들웨어가 있습니다. 가장 일반적으로 사용되는 것 중 하나는 Swagger UI 및 Swagger Editor입니다. Swagger UI는 웹 기반 인터페이스로 API 문서를 표시하고 상호 작용할 수 있는 도구입니다. Swagger Editor는 Swagger 스펙을 편집하고 검증하는 데 사용됩니다.

🔴 API 문서 작성

Swagger를 사용하여 API 문서를 작성하고 정의합니다. 이때 API 엔드포인트, 요청 및 응답 형식, 매개변수, 인증 설정 등을 정의합니다.

🔴 API 서버 통합

API 서버에 Swagger 도구 또는 미들웨어를 통합합니다. 이를 통해 API 서버는 Swagger 스펙을 이해하고 클라이언트에게 제공할 수 있습니다.

🔴 Swagger UI 또는 기타 클라이언트 사용

Swagger UI 또는 다른 클라이언트 도구를 사용하여 생성된 API 문서를 확인하고 API를 테스트할 수 있습니다.

---

🔵 Swagger 사용하는 회사

🔴 Google

Google은 자체 개발한 다양한 API를 관리하기 위해 Swagger를 사용합니다. Google Cloud Endpoints와 함께 Swagger 스펙을 사용하여 API 문서를 생성하고 제공하며, 개발자들이 Google Cloud 서비스를 사용하는 데 도움이 됩니다.

🔴 Microsoft

Microsoft는 Azure API Management와 함께 Swagger를 사용하여 API 문서를 자동으로 생성하고 관리합니다. 이를 통해 Azure 클라우드 서비스의 사용자와 개발자들에게 API를 쉽게 이해하고 사용할 수 있는 기회를 제공합니다.

🔴 IBM

IBM은 자체 클라우드 서비스 및 Watson API와 Swagger를 통합하여 API 문서 작성 및 관리를 단순화합니다. 이를 통해 IBM의 인공 지능 및 클라우드 서비스를 사용하는 개발자와 기업에게 API 액세스를 용이하게 만듭니다.

🔴 Salesforce

Salesforce는 RESTful API를 통해 개발자와 기업이 Salesforce 서비스에 액세스할 수 있도록 하고, 이 API 문서를 Swagger를 통해 제공합니다. 이를 통해 Salesforce 플랫폼을 사용하는 개발자들이 손쉽게 통합 애플리케이션을 작성하고 확장할 수 있습니다.

🔴 Twitter

Twitter는 자체 API를 Swagger를 사용하여 문서화하고, 개발자들이 Twitter 데이터를 효과적으로 사용할 수 있도록 지원합니다. 이를 통해 Twitter API를 활용한 애플리케이션과 서비스가 만들어집니다.

---

🔵 Swagger 스펙을 만들고 유지보수하는 회사

Swagger 스펙을 만들고 유지보수하는 회사는 API 문서화 및 관리 도구를 개발하고 제공하는 회사들이 주로 해당됩니다. 아래는 Swagger 스펙 및 관련 도구를 만들고 유지보수하는 몇 가지 회사와 프로젝트의 예시입니다:

🔴 SmartBear Software (Swagger/OpenAPI)

SmartBear Software는 Swagger 스펙과 관련 도구인 Swagger UI, Swagger Editor, Swagger Codegen을 개발하고 유지보수합니다. 이 도구들은 API 문서 작성, 테스트, 코드 생성 및 관리를 위해 널리 사용됩니다.

🔴 Apigee (Google Cloud)

Apigee는 Google Cloud의 일부로서 API 관리 및 문서화를 제공하는 플랫폼입니다. 이 플랫폼은 Swagger 스펙을 기반으로 API를 문서화하고 관리할 수 있도록 도와줍니다.

🔴 Redocly (Redoc)

Redocly는 Swagger와 OpenAPI 스펙에 기반한 API 문서화 및 관리 플랫폼을 제공하는 회사입니다. Redocly의 제품 중 하나인 "Redoc"는 Swagger 스펙을 사용하여 멋진 API 문서를 생성하는 데 사용됩니다.

🔴 Stoplight (Prism and Studio)

Stoplight는 API 디자인, 문서화 및 테스트를 위한 도구를 개발하고 유지보수합니다. "Prism"은 Swagger 스펙을 활용하여 실제 API 서버를 로컬 환경에서 시뮬레이션하고 테스트하는 데 사용되며, "Studio"는 API 디자인 및 문서화를 위한 통합 개발 환경입니다.

🔴 Postman

Postman은 API 개발 및 테스트를 위한 플랫폼으로, Swagger 스펙과 OpenAPI 스펙을 지원합니다. Postman을 사용하여 API 요청을 작성하고 테스트하며, 문서화 및 공유도 가능합니다.

출처 | ChatGPT