SWAGGER (2) 썸네일형 리스트형 [Swagger] Node.js에 Swagger 적용하기 (2) - OpenApI openapi.yaml 파일 뜯어보기 앞서 [Swagger] Node.js에 Swagger 적용하기(1) 에서 기본 설정을 해주는 openapi.yaml 파일을 자세하게 보려고 한다! 자세한 공식 문서는 이 링크에 openapi OpenAPI 사양의 버전을 명시해준다. 현재 코드에서는 OpenAPI 3.0.0을 사용한다. openapi: 3.0.0 info API 정보가 들어있다. version : API의 버전 title : API 이름 description : API에 대한 설명(확장 정보) license : API의 라이센스 정보 info: version: 1.0.0 title: Wooly API Docs description: Wooly API 문서입니다 license: name: MIT Serv.. [Swagger] Node.js에 Swagger 적용하기 (1) 시작하기 이전 프로젝트에서 주로 API 명세서는 Git Wiki 또는 엑셀 파일을 사용했다. 최근에 Swagger라는 프로그램이 많이 사용되고, 주변 개발자 친구들도 많이 사용하여 흥미가 생겼다. 현재 진행 중인 솝텀프로젝트에 이를 적용해보기로 했다! 프로젝트는 Node.js, express를 사용하고, TypeScript를 적용하려고 한다. express 프로젝트에 몇몇 API를 구현한 상태고, 여기에 Swagger를 적용할 것이다. 0. Install 먼저, swagger를 사용하기 위한 패키지들을 설치해준다. npm install swagger-ui-express yamljs swagger-ui-express 작성해둔 API 명세를 UI로 보여준다. yamljs yaml 파일을 읽어오기 위해 사용 .. 이전 1 다음
