Skip to content

README.md

Latest commit

 

History

History
90 lines (68 loc) · 1.42 KB

README.md

File metadata and controls

90 lines (68 loc) · 1.42 KB

About

Web API for retrieving Github user info, number of github repos, total number of commits, all the languages used by the user and user's achievements (github badges).

Examples

User Info:

GET /api/v1/user

Response:

{
  "message": "ok",
  "data": {
    "name": "S. M. Waesh Ahmed",
    "username": "ysahmed",
    "avatar_url": "https://avatars.githubusercontent.com/u/31134625?v=4",
    "html_url": "https://github.com/ysahmed"
  }
}

Get total repositories:

GET /api/v1/repos

Response:

{
  "message": "ok",
  "data": 15
}

Get total number of commits

GET /api/v1/commits

Response:

{
  "message": "ok",
  "data": 117
}

Get all used programming languages

GET /api/v1/languages

Response:

{
  "message": "ok",
  "data": ["Kotlin", "JavaScript", "C"]
}

Get all github achievements (badges)

GET /api/v1/achievements

Response:

{
  "message": "ok",
  "data": [
    {
      "achievement": "Starstruck",
      "img_url": "https://github.githubassets.com/images/modules/profile/achievements/starstruck-default--light-medium.png",
      "tier_text": "",
      "tier": "Default",
      "color": null
    },
    {
      "achievement": "Pair Extraordinaire",
      "img_url": "https://github.githubassets.com/images/modules/profile/achievements/pair-extraordinaire-default.png",
      "tier_text": "x2",
      "tier": "Bronze",
      "color": "#F9BFA7"
    }
  ]
}