규칙
- 에픽 태그를 둬서 그룹으로 나눠서 볼 수 있게 합니다.
- API의 상태를 상태 태그를 통해서 확인할 수 있게 합니다.
- 인라인 테이블 만들어서 그룹으로 관리해요 🙂
- 북마크, 캡쳐, 코드 남겨주세요.
확장 익스텐션
- mermaid.js
📏Response Convention
🐶 성공 예시
// 단일건 { "response": { "id": 3000001, "barcode": "49319927-68ed-4bc3-b022-6c099195f48c", "itemId": 10, "qty": 1 }, } // 다중건 { "response": [ { "id": 3000000, "barcode": "12cbf5bf-2c96-4172-acb6-4c24a853d255", "itemId": 6, "qty": 1 }, { "id": 3000001, "barcode": "49319927-68ed-4bc3-b022-6c099195f48c", "itemId": 10, "qty": 1 } // ... ], }
👾 실패 예시 (예외처리 응답)
{ "timestamp": "2022-06-15T16:28:39.390154", "message": "Could not found Product with barcode=49319927-68ed-4bc3-b022-6c099195f48" } { "code" : V0001 "message" : } // 병연 { timestamp : "사용자이름을 잘못 입력했습니다" .. }
코드 | 내용 |
v0012 | 아이디값 오류 |
v1231 | 비밀번호 오류 |