Skip to content

docs: add API example requests and responses to README #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Ai-chan-0411 wants to merge 1 commit into from
Closed

docs: add API example requests and responses to README #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,59 @@ pnpm run dev

---

## 📡 API Examples

### Compare two developers

**Request:**
```bash
GET /api/compare?username=torvalds&username=gvanrossum
```

**Response:**
```json
{
"success": true,
"users": [
{
"username": "torvalds",
"repoScore": 9850,
"prScore": 120,
"contributionScore": 45,
"finalScore": 4552,
"topRepos": [
{ "name": "linux", "stars": 180000, "forks": 52000 }
],
"topPullRequests": []
},
{
"username": "gvanrossum",
"repoScore": 4200,
"prScore": 980,
"contributionScore": 310,
"finalScore": 2370,
"topRepos": [
{ "name": "cpython", "stars": 61000, "forks": 29000 }
],
"topPullRequests": [
{ "title": "bpo-12345: fix typing module", "repo": "python/cpython" }
]
}
]
}
```

### Error response (user not found)

```json
{
"success": false,
"error": "GitHub user not found"
}
```

---

## 🌍 Localization

* Supported languages: English 🇺🇸, Arabic 🇸🇦
Expand Down
Loading