Swagger와 OAS를 알아보고 NodeJS에서 활용해보자!

1. Swagger?OAS?withNodeJS
임광규

2. WhatisSwagger?
스웨거(Swagger)는개발자가REST웹서비스를설계,빌드,문서화,소비하는일을도와주는
대형도구생태계의지원을받는오픈소스소프트웨어프레임워크이다.대부분의사용자들은스
웨거UI도구를통해스웨거를식별하며스웨거툴셋에는자동화된문서화,코드생성,테스트케
이스생성지원이포함된다.
Swagger는RESTAPI를설계,빌드,문서화및소비하는데도움이되는OpenAPI사양을기반으로
구축된오픈소스도구세트입니다.

3. Swagger특징
.API디자인
Swagger-editor를통해api를문서화하고빠르게명세할수있습니다.
.APIDevelopment
Swagger-codegen을통해작성된문서를통해SDK를생성하여빌드프로세스를간소화할수
있도록도와줍니다.문서를통해실행하면프로토타입코드를생성해주는데파일구조가정해져
있는것같습니다.
.APIDocumentation
Swagger-UI를통해작성된API를시각화시켜줍니다.
.APITesting
Swagger-Inspector를통해API를시각화하고빠른테스팅을진행할수있습니다.
.Standardize
Swagger-hub를통해개인,팀원들이API정보를공유하는Hub입니다.

4. Swagger2.0VSOpenApi3.0
사실은OpenApi2.0(2014년2.0발의)과3.0(2017년발의)

5. OPENAPIReversion

6. Swagger-node
Node.js에서Swagger호환API를디자인하고빌드하기위한도구를제공합니다.Express,
Hapi,Restify및Sails를비롯하여널리사용되는Node.js서버와모든Connect기반미들웨
어와통합됩니다.swagger를사용하면랩톱에서API를처음부터지정,빌드및테스트할수있
습니다.구현논리를다시쓰지않고도디자인을변경하고반복할수있습니다.

7. Swagger-node특징
Swagger2.0지원
오래되었음
5년이상됨(2015년시작)
업데이트가빈번하지않음
2018년이마지막업뎃
1년이상51Scrum에서사용됨

8. oas-tools
Express서버에서OpenAPI3.0사양으로정의된RESTfullAPI관리를지원합니다.

9. Oas-tools특징
OpenApi3.0지원
최신스펙을제공
2018년시작된프로젝트
업데이트가빈번함
2020년7월13일기준2020년6월18일이마지막업데이트
현재1개의프로젝트에서사용됨(issue_finder,newCollector)

10. 사용해보기
Swagger-node
oas-generator

11. 참고자료
https://ko.wikipedia.org/wiki/스웨거_(소프트웨어)
https://real-dongsoo7.tistory.com/58
Openapi2.0(2014년2.0발의)
Openapi3.0(2017년발의)
Swagger-node
oas-tools
oas-generator