npm run dev 명령어로 개발 서버를 시작할 수 있고, npm build로 ES5 스펙으로 빌드할 수 있습니다. npm start를 치면 빌드 후 실행합니다.
에러 코드는 error_type 속성에 들어가 있습니다.
| Error Code | description |
|---|---|
| NOT_FOUND | 액션을 찾을 수 없습니다. 404 스펙과 동일합니다. |
| SERVER_ERROR | 서버에서 에러가 발생했습니다. 500 스펙과 동일합니다. |
| NO_REQUIRED_ITEMS | 필수인 항목이 없을 때 발생하는 오류입니다. |
| UNIQUE_ERROR | 유니크한 항목에 이미 존재하는 것을 넣을 때 발생하는 오류입니다. |
| NOT_DEFIND_ENUM | 정해진 값 중 하나가 아닌 경우 발생합니다. |
| PERMISSION_DENINED | 권한이 없을 때 발생합니다. |
Restful하게 구성되었습니다.
User를 새로 만듭니다.
| 항목 | 설명 |
|---|---|
username |
사용자 인증에 사용될 id입니다. (필수)(유니크) |
password |
사용자 인증에 사용될 password입니다. SHA512 암호화 처리됩니다.(필수) |
name |
사용자의 이름입니다. (필수) |
email |
사용자의 이메일입니다. (필수)(유니크) |
phoneNumber |
사용자의 전화번호입니다. (필수)(유니크) |
age |
사용자의 나이대입니다. (10, 20, 30대 등 10 단위로 써도 됩니다.) (필수) |
StatusCode: 201
{
"success": true,
"username": "username",
"email": "[email protected]",
"phoneNumber": "010-1234-5678",
"age": "13"
}StatusCode: 400
{
"success": false,
"error_type": "NO_REQUIRED_ITEMS",
"error_message": "필수인 정보가 없습니다.",
"status_code": 400
}토큰을 발급받습니다. 토큰의 유효 기간은 5일입니다.
요청 예시
{
"provider": "local",
"email": "test1",
"password": "password"
}성공
{
"success": true,
"token": "Token....",
"username": "username",
"age": 10,
"phoneNumber": "010-1234-5678",
"email": "[email protected]",
"name": "Name"
}글을 씁니다. x-access-token 헤더에 토큰을 넣어주세요.
요청 예시
{
"title": "글의 제목",
"contents": "글의 내용"
}성공
{
"success": true,
"id": "글의 아이디"
}글들을 모두 받아옵니다. Query age에 나이 값을 넣어주세요. (17 등의 수를 넣어도 자동으로 10~19로 인식합니다.)
성공
{
"success": true,
"articles": [
{
"_id": "4ds8q3rf0dsf",
"title": "Hello World!",
"contents": "글",
"by": {
"_id": "352dsgsfg234",
"username": "닉네임"
},
"__v": 0
}
//...
]
}:id 글에 있는 댓글들을 가져옵니다.
성공
{
"success": true,
"comments": [
{
"content": "댓글",
"by": "Id",
"adopted": false
}
]
}:id 글에 댓글을 답니다. x-access-token 헤더가 필요합니다.
성공
{
"success": true,
"contents": "댓글 내용",
"id": "댓글 아이디"
}:id 글에 있는 :comment_id 댓글을 채택합니다. x-access-token이 필요하고, 유저가 같아야 합니다.
성공
{
"success": true
}todo 값을 저장합니다. x-access-token 헤더가 필요합니다. id 값은 나중에 on/off를 조절하기 위해 반드시 필요합니다.
요청
{
"title": "나는 돈이 많다"
"list": ["나는 1억 이상의 차가 있다.", "나는 통장잔고가 1.5억 이상 있다.", "나는 1000만원 이상의 시계가 있다.", "나는 20억 이상의 집에 살고 있다.", "나는 일을 안해도 평생 놀 수 있다."]
}응답
{
"success": true,
"id": "dsgsdgdsg"
}todo 값을 가져옵니다. x-access-token 헤더가 필요합니다.
응답
{
"success": true,
"todos": {
"_id": "id",
"title": "나는 돈이 많다",
"list": [{"todo": "나는 1억 이상의 차가 있다.", "completed": true}, ...]
}
}완료를 toggle. id는 만들어질 때 반환한 id. (idx는 배열의 index 값 예: 0, 1, 2...) x-access-token 헤더가 필요합니다.
응답
{
"success": true,
"todos": {
"_id": "id",
"title": "나는 돈이 많다",
"list": [{"todo": "나는 1억 이상의 차가 있다.", "completed": true}, ...]
}
}