ΠŸΡƒΠ±Π»ΠΈΡ‡Π½Ρ‹ΠΉ APIΠ Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ

Π Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ

Π­Ρ‚ΠΎΡ‚ Ρ€Π°Π·Π΄Π΅Π» API позволяСт Ρ€Π°Π±ΠΎΡ‚Π°Ρ‚ΡŒ с рСпозиториями GitVerse.

ΠŸΠΎΠ»ΡƒΡ‡Π΅Π½ΠΈΠ΅/ΠΎΠ±Π½ΠΎΠ²Π»Π΅Π½ΠΈΠ΅ ΠΈΠ½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΠΈ ΠΎ Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ

1. GET /repos/{owner}/{repo}

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ основныС Π΄Π°Π½Π½Ρ‹Π΅ ΠΎ Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ: Π½Π°Π·Π²Π°Π½ΠΈΠ΅, Π²Π»Π°Π΄Π΅Π»ΡŒΡ†Π°, настройки, ΠΏΡ€Π°Π²Π° ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ ΠΈ Ρ‚.Π΄.

2. PATCH /repos/{owner}/{repo}

ΠŸΠΎΠ·Π²ΠΎΠ»ΡΠ΅Ρ‚ ΠΈΠ·ΠΌΠ΅Π½ΡΡ‚ΡŒ ΠΊΠ»ΡŽΡ‡Π΅Π²Ρ‹Π΅ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ рСпозитория, Ρ‚Π°ΠΊΠΈΠ΅ ΠΊΠ°ΠΊ Π½Π°Π·Π²Π°Π½ΠΈΠ΅, описаниС, ΠΏΡ€ΠΈΠ²Π°Ρ‚Π½ΠΎΡΡ‚ΡŒ ΠΈ ΠΏΠΎΠ²Π΅Π΄Π΅Π½ΠΈΠ΅ ΠΏΡ€ΠΈ слиянии Π²Π΅Ρ‚ΠΎΠΊ.

3. POST /user/repos

Π‘ΠΎΠ·Π΄Π°Π΅Ρ‚ Π½ΠΎΠ²Ρ‹ΠΉ Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΉ для ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ.

4. DELETE /repos/{owner}/{repo}

УдаляСт ΡƒΠΊΠ°Π·Π°Π½Π½Ρ‹ΠΉ Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΉ.

Π£ΠΏΡ€Π°Π²Π»Π΅Π½ΠΈΠ΅ содСрТимым

5. GET /repos/{owner}/{repo}/contents/{path}

ΠŸΠΎΠ·Π²ΠΎΠ»ΡΠ΅Ρ‚ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ содСрТимоС Ρ„Π°ΠΉΠ»Π° (Π² Base64) ΠΈΠ»ΠΈ список Ρ„Π°ΠΉΠ»ΠΎΠ² Π²Π½ΡƒΡ‚Ρ€ΠΈ ΠΏΠ°ΠΏΠΊΠΈ.

6. PUT /repos/{owner}/{repo}/contents/{filename}

Π‘ΠΎΠ·Π΄Π°Π΅Ρ‚ Π½ΠΎΠ²Ρ‹ΠΉ Ρ„Π°ΠΉΠ» ΠΈΠ»ΠΈ обновляСт ΡΡƒΡ‰Π΅ΡΡ‚Π²ΡƒΡŽΡ‰ΠΈΠΉ Π² ΡƒΠΊΠ°Π·Π°Π½Π½ΠΎΠΉ Π²Π΅Ρ‚ΠΊΠ΅.

7. DELETE /repos/{owner}/{repo}/contents/{filename}

УдаляСт ΡƒΠΊΠ°Π·Π°Π½Π½Ρ‹ΠΉ Ρ„Π°ΠΉΠ» ΠΈΠ· рСпозитория.

8. GET /repos/{owner}/{repo}/git/trees/{tree_sha}

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ структуру Ρ„Π°ΠΉΠ»ΠΎΠ² ΠΈ ΠΏΠ°ΠΏΠΎΠΊ, ΡΠ²ΡΠ·Π°Π½Π½ΡƒΡŽ с ΡƒΠΊΠ°Π·Π°Π½Π½Ρ‹ΠΌ Π΄Π΅Ρ€Π΅Π²ΠΎΠΌ Git.

Π Π°Π±ΠΎΡ‚Π° с ΠΊΠΎΠΌΠΌΠΈΡ‚Π°ΠΌΠΈ

9. GET /repos/{username}/{reponame}/commits

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ список ΠΊΠΎΠΌΠΌΠΈΡ‚ΠΎΠ² рСпозитория с Π²ΠΎΠ·ΠΌΠΎΠΆΠ½ΠΎΡΡ‚ΡŒΡŽ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π°Ρ†ΠΈΠΈ ΠΏΠΎ Π²Π΅Ρ‚ΠΊΠ΅, ΠΏΡƒΡ‚ΠΈ, Π°Π²Ρ‚ΠΎΡ€Ρƒ, Π΄Π°Ρ‚Π΅ ΠΈ Π΄Ρ€ΡƒΠ³ΠΈΠΌ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Π°ΠΌ.

10. GET /repos/{username}/{reponame}/commits/{sha}

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΏΠΎΠ»Π½ΡƒΡŽ ΠΈΠ½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΡŽ ΠΎ ΠΊΠΎΠ½ΠΊΡ€Π΅Ρ‚Π½ΠΎΠΌ ΠΊΠΎΠΌΠΌΠΈΡ‚Π΅, Π²ΠΊΠ»ΡŽΡ‡Π°Ρ Π°Π²Ρ‚ΠΎΡ€Π°, сообщСниС, статистику ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠΉ ΠΈ список Π·Π°Ρ‚Ρ€ΠΎΠ½ΡƒΡ‚Ρ‹Ρ… Ρ„Π°ΠΉΠ»ΠΎΠ².

11. GET /repos/{username}/{reponame}/compare/{basehead}

Π‘Ρ€Π°Π²Π½ΠΈΠ²Π°Π΅Ρ‚ Π΄Π²Π΅ Π²Π΅Ρ‚ΠΊΠΈ, Ρ‚Π΅Π³Π° ΠΈΠ»ΠΈ ΠΊΠΎΠΌΠΌΠΈΡ‚Π° ΠΈ Π²ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Ρ€Π°Π·Π½ΠΈΡ†Ρƒ ΠΌΠ΅ΠΆΠ΄Ρƒ Π½ΠΈΠΌΠΈ (Π°Π½Π°Π»ΠΎΠ³ git diff). ПолСзно для Π°Π½Π°Π»ΠΈΠ·Π° ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠΉ ΠΏΠ΅Ρ€Π΅Π΄ созданиСм Pull Request.

12. POST /repos/{username}/{reponame}/git/refs

Π‘ΠΎΠ·Π΄Π°Π΅Ρ‚ Π½ΠΎΠ²ΡƒΡŽ Git-ссылку (Π²Π΅Ρ‚ΠΊΡƒ, Ρ‚Π΅Π³ ΠΈΠ»ΠΈ ΠΊΠ°ΡΡ‚ΠΎΠΌΠ½ΡƒΡŽ ссылку) Π² Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ.

Π”ΠΎΠΏΠΎΠ»Π½ΠΈΡ‚Π΅Π»ΡŒΠ½Ρ‹Π΅ ΠΌΠ΅Ρ‚ΠΎΠ΄Ρ‹

13. GET /repos/{owner}/{repo}/issues

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ список Π·Π°Π΄Π°Ρ‡ (issues) рСпозитория. На Π΄Π°Π½Π½Ρ‹ΠΉ ΠΌΠΎΠΌΠ΅Π½Ρ‚ содСрТит Ρ‚ΠΎΠ»ΡŒΠΊΠΎ запросы Π½Π° слияниС (Pull Requests).

14. GET /repos/{owner}/{repo}/issues/comments/{id}

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Π΄Π΅Ρ‚Π°Π»ΠΈ ΠΎΡ‚Π΄Π΅Π»ΡŒΠ½ΠΎΠ³ΠΎ коммСнтария ΠΏΠΎ Π΅Π³ΠΎ ΡƒΠ½ΠΈΠΊΠ°Π»ΡŒΠ½ΠΎΠΌΡƒ ΠΈΠ΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€Ρƒ (id).

15. GET /repos/{owner}/{repo}/issues/{index}

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΏΠΎΠ΄Ρ€ΠΎΠ±Π½ΡƒΡŽ ΠΈΠ½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΡŽ ΠΎ Π·Π°Π΄Π°Ρ‡Π΅ (issue) ΠΈΠ»ΠΈ запросС Π½Π° слияниС (pull request) ΠΏΠΎ Π΅Π³ΠΎ индСксу Π² Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ.

16. GET /repos/{owner}/{repo}/issues/{index}/comments

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ список всСх ΠΊΠΎΠΌΠΌΠ΅Π½Ρ‚Π°Ρ€ΠΈΠ΅Π², оставлСнных ΠΊ Π·Π°Π΄Π°Ρ‡Π΅ (issue) ΠΈΠ»ΠΈ ΠΏΡƒΠ»-рСквСсту (pull request) с ΡƒΠΊΠ°Π·Π°Π½Π½Ρ‹ΠΌ индСксом.

17. GET /repos/{owner}/{repo}/issues/{index}/labels

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ список ΠΌΠ΅Ρ‚ΠΎΠΊ (labels), Π½Π°Π·Π½Π°Ρ‡Π΅Π½Π½Ρ‹Ρ… Π½Π° Π·Π°Π΄Π°Ρ‡Ρƒ (issue) ΠΈΠ»ΠΈ Π½Π° запрос Π½Π° слияниС (pull request) с ΡƒΠΊΠ°Π·Π°Π½Π½Ρ‹ΠΌ индСксом.

18. GET /repos/{owner}/{repo}/issues/{index}/timeline

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Ρ…Ρ€ΠΎΠ½ΠΎΠ»ΠΎΠ³ΠΈΡŽ всСх событий ΠΈ ΠΊΠΎΠΌΠΌΠ΅Π½Ρ‚Π°Ρ€ΠΈΠ΅Π², связанных с Π·Π°Π΄Π°Ρ‡Π΅ΠΉ (issue) ΠΈΠ»ΠΈ с запросом Π½Π° слияниС (pull request).

19. GET /repos/{owner}/{repo}/languages

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ список языков, ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅ΠΌΡ‹Ρ… Π² Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ, с ΡƒΠΊΠ°Π·Π°Π½ΠΈΠ΅ΠΌ количСства строк ΠΊΠΎΠ΄Π° Π½Π° ΠΊΠ°ΠΆΠ΄ΠΎΠΌ.

20. POST /repos/{owner}/{repo}/forks

Π‘ΠΎΠ·Π΄Π°Π΅Ρ‚ Ρ„ΠΎΡ€ΠΊ рСпозитория для Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ.

21. PUT /repos/{owner}/{repo}/collaborators/{username}

ДобавляСт ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ ΠΊΠ°ΠΊ соавтора рСпозитория ΠΈΠ»ΠΈ обновляСт Π΅Π³ΠΎ ΡƒΡ€ΠΎΠ²Π΅Π½ΡŒ доступа.

Π’ΠΎΠ·ΠΌΠΎΠΆΠ½Ρ‹Π΅ ошибки

КодОписаниС
400 Bad RequestНСкоррСктный Ρ„ΠΎΡ€ΠΌΠ°Ρ‚ Π΄Π°Π½Π½Ρ‹Ρ…
401 UnauthorizedНСобходима авторизация
403 ForbiddenНСдостаточно ΠΏΡ€Π°Π²
404 Not FoundΠ Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΉ Π½Π΅ Π½Π°ΠΉΠ΄Π΅Π½
409 ConflictΠšΠΎΠ½Ρ„Π»ΠΈΠΊΡ‚ SHA (ΠΏΡ€ΠΈ ΡƒΠ΄Π°Π»Π΅Π½ΠΈΠΈ Ρ„Π°ΠΉΠ»Π° Π±Π΅Π· указания sha)
500 Internal Server ErrorВнутрСнняя ошибка сСрвСра

Π’Ρ‹ нашли Ρ‡Ρ‚ΠΎ искали?