Языки программирования

Получение информации о языках программирования в репозитории
Beta

Описание

Этот раздел документации описывает конечную точку для получения информации о языках программирования, используемых в указанном репозитории. Ответ содержит список языков и объем кода (в байтах), написанного на каждом из них.

Общие замечания

  1. Для версий API указывайте заголовок Accept с соответствующей версией:
Accept: application/vnd.gitverse+json;version=1
  1. Для работы с приватными ресурсами требуется авторизация через Bearer токен:
Authorization: Bearer \{user_token}
  1. Базовый URL для всех конечных точек:
https://api.gitverse.ru
  1. Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Описание метода

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

Параметры пути

  • {owner} — имя владельца репозитория (пользователя или организации);
  • {repo} — название репозитория.

Заголовки запроса

  • Content-Type: application/json: указывает, что тело ответа будет в формате JSON;
  • Accept: application/vnd.gitverse+json;version=1: указывает версию API. В данном случае используется версия 1;
  • Authorization: Bearer {user_token} (опционально): требуется для доступа к приватным репозиториям.

Тело запроса

Тело запроса не требуется. Этот метод работает без передачи данных в теле запроса.

Параметры ответа

Ответ содержит объект, где ключи — это названия языков программирования, а значения — количество байт кода, написанного на соответствующем языке.

Пример структуры ответа

{
	"Go": 16048,
	"Java": 4475
}

Где:

  • {language} (string): название языка программирования;
  • {bytes} (integer): количество байт кода, написанного на этом языке.

Если в репозитории отсутствуют файлы с поддерживаемыми языками программирования, ответ будет пустым объектом.

{}

Пример запроса

GET https://api.gitverse.ru/repos/qweqwe1/russia_template/languages
Content-Type: application/json
Accept: application/vnd.gitverse+json;version=1
Authorization: Bearer YOUR_ACCESS_TOKEN

Пример ответа

{
	"Go": 16048,
	"Java": 4475
}

Обработка ошибок

Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Пример ошибки

{
	"error": "Repository not found",
	"message": "The requested repository does not exist or you do not have access to it.",
	"status": 404
}

Возможные коды ошибок

  • 400 Bad Request: неверный запрос (например, отсутствие обязательных параметров);
  • 401 Unauthorized: необходима авторизация;
  • 403 Forbidden: у пользователя нет прав на выполнение действия;
  • 404 Not Found: репозиторий не найден;
  • 500 Internal Server Error: внутренняя ошибка сервера.

Дополнительная информация

  1. Если репозиторий является приватным, доступ к нему возможен только при наличии соответствующих прав.
  2. Если в репозитории отсутствуют файлы с поддерживаемыми языками программирования, ответ будет пустым объектом:
    {}
  3. Для использования конечной точки может потребоваться авторизация через Bearer токен, особенно если запрашиваемый репозиторий является приватным.
  4. Все данные о языках программирования рассчитываются автоматически на основе анализа файлов в репозитории.

Если у вас возникнут вопросы или потребуется дополнительная информация, пожалуйста, обратитесь к документации API или свяжитесь с поддержкой.