fan.catholic.ac.kr-api-reference

fan.catholic.ac.kr 의 API Reference Repository 입니다.

작성예시

로그인 (토큰흭득) (예시)

• (예시) 부분에 프론트가 백엔드에게 요청하는 경우 ( 요청 ), 프론트가 요청한 API 백엔드가 제작 완료한 경우 ( 완료 )

• URI : fan.catholic.ac.kr:5000/login

• METHOD : POST

• request

  key	explanation	type
  username	user id	string
  password	password	string

• response code

  • Header : Content-Type : application/json

  • ERROR RESPONSE

    key	explanation	type
    error_code	오류 코드	integer
    error_msg	오류 내용	string

    • error_code (오류 별 반환 내용 및 상태)

      HTTP STATE	error_code	explanation
      400	0	파라미터 오류, 상세 내용은 error_msg 참고
      401	1	토큰 만료
      401	2	토큰이 존재하지 않음

  • SUCCESS RESPONSE

    key	explanation	type
    token	발급 토큰(클라이언트에서 저장하세요!)	string
    created	토큰 발급 일 시	string