[AI스쿨] swagger란 무엇인가?

#AI스쿨 #swagger #swagger란

​

AI스쿨 msa기반 java 백엔드 코스 중에 공부한 내용을 작성하였습니다.

학습법 이론

학습을 하기 이전, 명심해야할 학습법이 있다.

​

1.이해가지 않는다고 뒤돌아가 다시 보지 말 것

2.외우지 말라

=> 자주 봐서 외워짐을 당하라

=> 크롬을 통해 copy and paste하라

1. 이해하는게 중요하다

=> 왜 생겨났는지?

=> 왜 사용하는지?

===> 응용이 가능해진다.

4.새로운 지식을 넣을땐 뇌를 비우자

swagger란?

swagger란?

swagger란 API명세서(설명서)를 만들어주는 도구입니다. 보통 웹페이지를 만든 후 프론트엔드 개발자는 백엔드 개발자에게 API명세서를 받습니다. API명세서를 활용해 프론트엔드 개발자는 서버에 저장된 데이터를 불러오거나 수정하는 등 데이터를 가공할 수 있습니다.

​

왜 등장했나요?

예전에는 이 명세서를 github, wiki, md파일 ,excel, notion등으로 전달하였습니다. 이렇게 전달할 경우 작성자가 모두 수기로 작성해야하기에 생산성이 많이 떨어집니다. 명세서를 더 빠르고 효율적이개 만들어 낼 수 있도록, swagger모듈이 개발되었습니다!

swagger맛만보기

swagger hub

swagger는 간단하게 swagger hub사이트에 접속하시면 사용이 가능합니다. (구글링 GO) 사이트에 접속하시어 간단하게 로그인 후 (구글연동가능) 직접 사용해보겠습니다.

swagger hub에 들어가시면 샘플데이터를 제공합니다. 아무거나 클릭해 보면 yaml파일 형태로 명세되어있는것을 볼 수 있습니다. yaml파일 관련해서는 나중에 글을 올려보도록 하겠습니다.(yaml파일 작성법)

swagger는 서버와 연결하여 API작동이 잘되는지 직접 확인하실 수 있는 기능도 제공합니다. REST를 먼저 공부하고 오셔야만 제대로 이해할 수 있습니다.(REST란?)

우선은 여기까지 해보면서 swagger hub에서 제공하는 명세서를 이것저것 둘러보세요! 완벽히 이해하실 필요는 없고 이런것이 있구나 정도만 넘어가시면 좋을 것 같습니다!

​

다음글에는 express js와 swagger를 연동하여 사용하는 방법에 대해 알아보겠습니다.