Skip to content

bye bye company API Document

Jump to bottom
Hyeonwoo Cho edited this page Jul 29, 2018 · 16 revisions

bye bye company API Document

HOST

http://localhost:3000/

API

name method uri
유저 로그인 정보 저장하기 POST /auth/register
내정보 작성하기 POST /user/{userId}/info
내정보 조회하기 GET /user/{userId}/info
메인화면 조회하기 GET /user/{userId}/main
현재 사직서 사유 조회하기 GET /user/{userId}/resignation
사직서 사유 작성하기 POST /user/{userId}/resignation
사직서 제출하기 화면 조회하기 GET /user/{userId}/resignation/submit
단일 사직서 조회하기 GET /user/{userId}/resignation/{resignationId}

유저 로그인 정보 저장하기

URI

POST /auth/register

REQUEST

{
   "id": "889870181",
   "name": "홍길동"
}

RESPONSE 200 : OK

{ "status": "200 : OK" }

404 : NOT FOUND

미구현

500 : INTERNAL SERVER ERROR

미구현

DESCRIPTION OF THE FIELD

key type description
id string 카카오톡 유저 id
name string 카카오톡 유저명

내정보 작성하기

URI

POST /user/{userId}/info

REQUEST

{
   "join_year": "2018",
   "join_month": "07",
   "join_day": "28",
   "company_name": "오프널",
   "department": "개발팀",
   "position": "개발자"
}

RESPONSE

200 : OK

{ "status": "200 : OK" }

404 : NOT FOUND

미구현

500 : INTERNAL SERVER ERROR

미구현

DESCRIPTION OF THE FIELD

key type description
join_year string 입사연도
join_month string 입사월
join_day string 입사일
company_name string 회사명
department string 소속
position string 직위
max_reason int 사직사유 최대 개수

내정보 조회하기

URI

GET /user/{userId}/info

REQUEST

body 없음

RESPONSE

{
   "join_year": "2018",
   "join_month": "07",
   "join_day": "28",
   "company_name": "오프널",
   "department": "개발팀",
   "position": "개발자",
   "resignation_num": 1
}

DESCRIPTION OF THE FIELD

key type description
join_year string 입사연도
join_month string 입사월
join_day string 입사일
company_name string 회사명
department string 소속
position string 직위
resignation_num int 작성한 사직서 개수

메인화면 조회하기

URI

GET /user/{userId}/main

REQUEST

body 없음

RESPONSE

{
   "company_name": "NHN",
   "attendance_day": 45,
   "current_reason_count": 1,
   "resignation": [
                     {
                        "resignation_id": 1,
                        "first_reason": "가나다라",
                        "second_reason": "마바사아",
                        "third_reason": "자차카타파하",
                        "date": "2018-07-27"
                     },
                     {
                        "resignation_id": 2,
                        "first_reason": "abcde",
                        "second_reason": "fghij",
                        "third_reason": "klmno",
                        "date": "2018-07-28"
                     }
                  ]
}

DESCRIPTION OF THE FIELD

key type description
company_name string 회사명
attendance_day string 현재까지 근무일수
current_reason_count string 현재 사직서 사유 개수
resignation array 사직서
resignation_id int 사직서 id
first_reason string 첫번째 사유
second_reason string 두번째 사유
third_reason string 세번째 사유
date string 사직서 작성 일자

현재 사직서 사유 조회하기

URI

GET /user/{userId}/resignation

REQUEST

body 없음

RESPONSE

{
   "resignation_id": 1,
   "first_reason": "첫번째 사유입니다.",
   "second_reason": "두번째 사유입니다.",
   "third_reason": "",
   "current_reason_count": 2
}

DESCRIPTION OF THE FIELD

key type description
resignation_id int 사직서 id
first_reason string 첫번째 사유
second_reason string 두번째 사유
third_reason string 세번째 사유
current_reason_count int 현재 사직서 사유 개수

사직서 사유 작성하기

URI

POST /user/{userId}/resignation

REQUEST

[
   {
      "reason": "오늘은 아침부터 과장님이 심한 말을 하셨다."
   }
]

RESPONSE

200 : OK

[
   { "status": "200 : OK" }
]

404 : NOT FOUND

미구현

500 : INTERNAL SERVER ERROR

미구현

DESCRIPTION OF THE FIELD

key type description
reason string 사직서 사유

사직서 제출하기 화면 조회하기

URI

GET /user/{userId}/resignation/submit

REQUEST

body 없음

RESPONSE

{
   "department": "개발팀",
   "position": "개발자",
   "name": "홍길동",
   "first_reason": "변환된 첫번째 사유입니다.",
   "second_reason": "변환된 두번째 사유입니다.",
   "third_reason": "변환된 세번째 사유입니다.",
   "join_year": "2018",
   "join_month": "07",
   "join_day": "28"
}

DESCRIPTION OF THE FIELD

key type description
department string 소속
position string 지위
name string 이름
first_reason string 변환된 첫번째 사유
second_reason string 변환된 두번째 사유
third_reason string 변환된 세번째 사유
join_year string 입사연도
join_month string 입사월
join_day string 입사일

단일 사직서 조회하기

URI

GET /user/{userId}/resignation/{resignationId}

REQUEST

body 없음

RESPONSE

[
   {
      "before_first_reason": "변환 전 첫번째 사유입니다.",
      "before_second_reason": "변환 전 두번째 사유입니다.",
      "before_third_reason": "변환 전 세번째 사유입니다.",
      "after_first_reason": "변환 후 첫번째 사유입니다.",
      "after_second_reason": "변환 후 두번째 사유입니다.",
      "after_third_reason": "변환 후 세번째 사유입니다.",
      "date": "2018-07-28"
   }
]

DESCRIPTION OF THE FIELD

key type description
before_first_reason string 변환 전 첫번째 사유
before_second_reason string 변환 전 두번째 사유
before_third_reason string 변환 전 세번째 사유
after_first_reason string 변환 후 첫번째 사유
after_second_reason string 변환 후 두번째 사유
after_third_reason string 변환 후 세번째 사유
date string 사직서 작성일자
Clone this wiki locally