swagger 사용해보기
swagger을 사용해보려고 찾아보았으나 제대로 이해한지는 잘 모르겟습니다. 스프링으로 알려주거나 nodejs이긴하나 yarn으로 알려주기도 해서 일단 왜 사용하는지는 알았습니다.
저희가 작성을 하거나 이제 새로운 기능을 추가할때 수동적으로 api 를 써주거나 변경해주어야 하는데 이게 손이 많이 가니 swagger를 사용하게 되면 자동으로 api가 만들어지고 보기에도 명확하게 잘보여서 프론트엔드도 같이 편해진다는 것입니다.
그래서 혹시 몰라 문제가 생길까 싶어 swagger를 시도하기 위해 lv4 코드를 복제해서 파일을 하나 새로 팠습니다.
swagger을 적용하려는데 생각보다 어렵습니다.
아래 참고자료들을 통해 유저 회원가입과 로그인을 만들어서 나왔습니다.
나머지도 해보려 합니다.
게시글 중 post인 게시글 작성과 get 중 게시글 전체목록 조회는 되었으나 지금 상세조회 get이 되지않아 찾아보고 있습니다.
작성중 아래 사진과 같이 나오는데 이상함을 느껴 확인해보니 저 Users 와 Posts 뒤에 description으로 작성한 값들이 나와야하는데 나오지가 않았습니다.
아래와 같이 routes index.js 파일에 작성했는데 description이 나오지 않았습니다.
뭔가 잘못 된거 같아서 찾아보고 있습니다.
찾아보니 swagger 파일에서 routes/index.js 를 참고하지 않아서 였습니다.
그래서 아래와 같이 swagger.js 파일을 수정해주니 그아래 사진처럼 잘 나왔습니다.
참고자료를 통해 각자 파일을 하나씩 만들어서 만들어뒀던 routes파일들을 각각에 넣어서 각자의 index.js 파일에 swagger 코드들을 작성해주었습니다.
어디가 문제인지 모르게 같은 코드라고 느껴지는데도 오류가 자주 났고, 바뀐것이 없다고 생각하는데 잘되기도 하고 좀 힘들었습니다.
틀은 만들어졌으나 이제 시도를 해보려고 합니다.
회원가입부터 시도를 해보았으나 오류가 났습니다.
어디가 문제인지 찾아보고 수정해보려합니다.
음 일단 제생각에는 sequelize를 사용해서 rds db에 저장하는데 현재 까지 작성했던 swagger는 예전에 작성했던 schma를 사용하는거 같습니다.
그래서 이번에는 sequelize를 사용하는 swagger를 찾아 적용해보려합니다.
..어 위에 생각한것은 틀린거 같습니다.
이것저것 수정해보면서 테스트를 하다 회원가입이 얻어걸렸습니다.
로그인도 되었고, 나머지는 내일 이어서 하고, 오후에는 swagger를 잠시 미루고 lv5 과제를 하려고 합니다.
참고자료