2.0.API - YOOGOMJA/github_garden_mern GitHub Wiki

API 명세

모든 API 명세 입니다.

• 1. API/analysis : 분석 항목
• 2. API/challenges : 도전 기간 관련 항목
• 3. API/repos : 저장소 관련 항목
• 4. API/users : 사용자 관련 항목

응답 예제

모든 API의 응답 형태는 일괄적인 형태를 띕니다. 응답의 기본 형태는 다음과 같습니다.

interface GitFarmResponseInterface{
  code : number,    // 응답 번호입니다. 양수인 경우 성공, 음수인 경우 오류입니다.
  status : string,  // 응답 상태를 문자열로 출력합니다. 성공은 'SUCCESS' 실패는 'FAIL' 로 출력됩니다.
  message : string, // 응답 상태에 대한 상세한 정보를 메시지로 출력합니다.
  data? : any,      // 응답이 성공했을 때, 데이터를 반환할 경우 포함됩니다.
  error? : any,     // 응답이 실패했을 때, 에러를 포함합니다.
}

다음은 /api/users/:user_name의 결과물 예제입니다.

{
    "code": 1,
    "status": "SUCCESS",
    "message": "조회에 성공했습니다",
    "data": {
        "_id": "5ebeb22cc6163456d41d2c61",
        "id": 15305733,
        "login": "yoogomja",
        "html_url": "https://github.com/YOOGOMJA",
        "name": "KyeongSoo Yoo",
        "blog": "http://yoogomja.github.io",
        "email": null,
        "bio": "91. S.Korea \r\nSAHMYOOK univ. Computer Science dept.\r\n\r\nWeb / iOS Programmer",
        "api_url": "https://api.github.com/users/YOOGOMJA",
        "events_url": "https://api.github.com/users/YOOGOMJA/events{/privacy}",
        "__v": 0
    }
}