Swagger가 뭔가요
·
👩🏻‍💻 𝐋𝐚𝐧𝐠𝐮𝐚𝐠𝐞/⠀⠀⠀⠀ Nᴏᴅᴇ.Jꜱ
API-Docs 사용하는 이유 프론트엔드 사람들에게 어떤 기능이고 어떻게 사용하는 것 인지를 명시해줘야 된다 api만 만드는 것이 아닌 항상 docs를 같이 만들어야 한다 보통 API 위에다 정의하기도 하지만 그렇게 할 경우 소스코드가 너무 길어지기 때문에 별도의 파일이나 폴더를 생성하여 구분해 관리하기도 한다 별도의 파일로 관리 시 Import필요 라이브러리 swagger-ui-express npm i swagger-ui-express yarn add swagger-ui-express swagger-jsdoc yarn add swagger-jsdoc 기본 템플릿 /* @openapi / : get : descriptionb : Welcome to swagger-jsdoc responses : 200 :..
유리쯔의일상
'DOC' 태그의 글 목록