ungh

> 编程语言

Open source

Unlimited access to github API

684 stars0 likes2 views

Website GitHub

About

Unlimited access to github API

ungh.cc

Unlimited access to GitHub API.

[!IMPORTANT]

/repos//files/ endpoint redirects to original raw.githubusercontent.com endpoint due to service absue. (#123).

Why UNGH?

Accessing to open source GitHub repository meta-data should be fast, easy, and straightforward. GitHub API is rate limited and requires an authentication token to increase limits. Even by using an API token, we need to share or generate it for each deployment and local development of apps and also deal with (increased) rate limits and deployment caching. GitHub REST API is also complex with (unnecessary) bigger payloads because of backward compatibility.

UNGH provides a simplified, cached, and anonymous layer to make GitHub API more enjoyable!

API

`/repos/{owner}/{name}`

GitHub repository information.

Example: https://ungh.cc/repos/unjs/h3

json

{
  "repo": {
    "id": 313641207,
    "name": "h3",
    "repo": "unjs/h3",
    "description": "Minimal h(ttp) framework built for high performance and portability ⚡️",
    "createdAt": "2020-11-17T14:15:44Z",
    "updatedAt": "2022-11-05T21:38:43Z",
    "pushedAt": "2022-11-06T06:48:23Z",
    "stars": 1168,
    "watchers": 1168,
    "forks": 59,
    "defaultBranch": "main"
  }
}

`/repos/{owner}/{name}/contributors`

Get repository contributors.

Example: https://ungh.cc/repos/unjs/h3/contributors

json

{
  "contributors": [
    {
      "id": 5158436,
      "username": "pi0",
      "contributions": 243
    },
    {
      "id": 29139614,
      "username": "renovate[bot]",
      "contributions": 41
    }
  ]
}

`/repos/{owner}/{name}/files/{branch}`

Get repository files tree on specific branch.

Example: https://ungh.cc/repos/unjs/h3/files/main

json

{
  "meta": {
    "sha": "501f0c6e623ea827d47691046f3c7319f5ac4651"
  },
  "files": [
    {
      "path": "README.md",
      "mode": "100644",
      "sha": "4c2b9ce4bccd6e046cd71be1a8c5e53a62778858",
      "size": 5782
    }
  ]
}

`/repos/{owner}/{name}/readme`

Get repository readme file on main branch (not cached)

Example: https://ungh.cc/repos/unjs/h3/readme

json

{
  "html": "

 Hosting sponsored by Vercel

## License

Developed by [@pi0](https://github.com/pi0) and [contributors](https://github.com/unjs/ungh/graphs/contributors).

Source code is published under the [MIT License](./LICENSE).