240530 TIL 서른두번째날 - API 명세서 작성

주제1	API 명세서 작성
작성이유	익숙해지기 위해. 과제 때 막상 쓰려고 하면 명세서 작성하는게 익숙치 않아서 허둥대서 시간낭비 되므로

 

문제상황

상황	
해결방법	익숙해질 때까지 작성해본다... 안되면 손으로 써서 익숙해져본다... (나는 여기에 시간 낭비하는게 아까워서 인쇄했다...) api 에 상세히 쓴다. success에 보통 ()안의 내용 안쓰는데 문서 여러번 안뒤져볼 수 있게 차라리 다 쓰는 것도 좋을 것 같다. 익숙해질 때 까지?
해결방법 풀이	등록 및 문서 만들기 : post / 조회 : get / 수정 : put(전체수정) , patch(일부수정) / 삭제 : delete url : 같은 맥락 끼리 묶는다. : 이력서 등록/ 이력서 조회/이력서 삭제 모두 이력서이므로 /resume /resume/:id 의 :id는 여러 이력서 중에서 하나만 선택하므로 뒤에 보통은 번호가 붙는다. (정보를 보내면 id가 자동생성되므로 그 아이디를 가져와서 번호에 입력함) (내가 작성한 파일이 resume관련된 파일.js에 있다면 아마 app.js에 app.use('/api',resume관련된 파일) 있음 => 보통은 localhost:포트번호/api/resume 요렇게 시작한다) 요청정보 : req. body (내가 전달받을 내용) 유효성 검증 : Failure (실패지 작성할 메세지 및 상태코드) : 보통 맨 아래에 있음 반환정보 : res (성공시 전달해줄 내용) 성공시 { "상태코드" : 201, "성공 메세지" : "이력서 생성 성공", "data" : { 반환정보 - 이력서 아이디 등등   } } 상태코드 : 200 - 요청성공 201 - 요청 성공 & 새로운 리소스 생성 (여기서는 이력서 생성) 400 - 사용자가 입력값을 빠트리는 등의 잘못했을 때 ; 잘못된 요청입니다 등 401 - 인증실패 ; 비밀번호 틀림등 403 - 접근권한없음 ; 인가 실패 404 - 요청한 리소스 찾을 수 없음 : URL인식 되지 않음 409 - 서버와 충돌 ; 이메일 중복 등 500 - 예상치 못한 에러 ; 서버에러
그 외

참고 사이트 https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

HTTP response status codes - HTTP | MDN

 

 

 

 

 

---

TIL 틀을 만들어 봤다.

 

https://8naji.tistory.com/notice/172

나의 TIL 규칙