Enterprise APP

Swagger란? 본문

API & Doc/Swagger

Swagger란?

로드스타 2016. 10. 28. 16:15

Swagger

: RESTful API를 설명하고 표현하기 위한 프로젝트.


Swagger Specification(스펙)

: API를 설명하고 쉽게 표현하기 위한 정의와 규칙들의 모음.(현재 스펙 2.0)


사용상의 장점

: API를 보다 이해하기 쉽도록 보여주고 다양한 프로그래밍 언어의 코드로 자동생성이 가능하다. 아울러 다양한 툴을 함께 사용하여 결과 파일이나 테스팅 용도로도 활용.


스펙 파일 포맷

: 표준 JSON 또는 YAML 형태로 Swagger Spec을 저장해서 사용.


스펙 파일 구조

: 한 개의 파일로 spec을 정의하지만 여러개의 파일로 spec을 나눠서 사용가능.



스키마

: API 스펙을 위한 root 오브젝트로 필드(Field)의 세트들로 구성되며 이는 다시 고정형 필드와 패턴형 필드로 나뉜다.

 


Comments