Web Technologies 🖥️/etc2 API 명세서 자동화 - swagger (feat. express.js) Swagger의 주요 특징자동화된 API 명세서 생성코드 주석을 통해 API 명세서를자동으로 생성할 수 있다사용자 친화적인 UI누구나 API 명세서를시각적으로 이해할 수 있다API 테스트 기능직접 API를 호출하고테스트할 수 있는 기능을 제공 swagger 관련 패키지 설치npm install swagger-jsdoc swagger-ui-express swagger 설정 파일 생성const swaggerJsDoc = require('swagger-jsdoc');const swaggerUi = require('swagger-ui-express');const swaggerOptions = { swaggerDefinition: { openapi: '3.0.0', info: { title.. 2024. 10. 10. API 응답 구조화 (feat... 유틸 클래스) API 서버를 개발할 때클라이언트와 원활한 소통을 위해일관된 응답 구조 방식을 채택할 수 있다 API 엔드포인트에서성공 여부와 에러를 전달할 때일정한 포멧으로 응답을 주고 받으면클라이언트에서 예측 가능한 처리가 가능하다 유틸 클래스의 필요성API의 갯수가 많아질수록 동일한 형태의성공 / 실패 응답을 자주 사용하게 될 가능성이 높다이는 자연스래 중복된 코드로 이어지고유지보수 또한 까다로워진다 동일한 엔드포인트에서성공 / 실패 여부에 따른 응답을위와 같이 설정할 수 있다성공 시 응답 데이터{ "result": true, "errNum": null, "data": { "message": "Registration Success" }} 실패 시 응답 데이터{ "result": false, "err.. 2024. 3. 8. 이전 1 다음 728x90 반응형
