GitVerse REST API OpenAPI Description

Официальные спецификации Публичного API GitVerse в формате OpenAPI 2.0 (Swagger).

Что такое OpenAPI?

OpenAPI Specification (ранее Swagger) — это стандартный, не зависящий от языка программирования интерфейс для описания HTTP API, который позволяет как людям, так и компьютерам понимать возможности сервиса без доступа к исходному коду, документации или анализу сетевого трафика.

Статус проекта

Спецификации считаются стабильными и готовы к использованию. Репозиторий автоматически обновляется при релизе новой версии API или обновлении документации.

Структура репозитория

/v1/
  ├── openapi-1.0.json
  ├── openapi-1.1.json
  ├── openapi-1.2.json
  └── openapi-1.3.json
/v2/
  ├── openapi-2.0.json
  ├── openapi-2.1.json
  └── openapi-2.2.json
/v3/
  ├── openapi-3.0.json
  └── openapi-3.1.json
...

Версионирование

Каждая директория (

1. MAJOR-версия API (например,
   version=2
   ) определяет контракт (эндпоинты, параметры, форматы).
2. Минорные версии спецификации (например,
   2.0
   →
   2.1
   ) не меняют контракт — они вносят только уточнения в документацию, исправления описаний или примеров.

Использование

Прямые ссылки

1. Версия 1:
   /v1/openapi-1.0.json
   .
2. Версия 2:
   /v2/openapi-2.0.json
   .
3. Версия 3:
   /v3/openapi-3.0.json
   .

Генерация клиентских SDK

Используйте спецификации для генерации клиентских SDK на любом языке программирования.

Быстрый старт

Указание версии API

Всегда указывайте версию API через заголовок

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

⚠️ Важно

1. Независимость версий: Версии API не привязаны к внутренним релизам GitVerse.
2. Поддержка версий: Устаревшие MAJOR-версии удаляются из репозитория после окончания срока поддержки (6 месяцев с момента выхода следующей MAJOR-версии).

Ограничения

• спецификация описывает только публичные эндпоинты API;
• некоторые параметры могут требовать дополнительной кодировки;
• для работы с API требуется аутентификация.

Внесение вклада

Мы приветствуем сообщество к улучшению документации! Если вы обнаружили:

• несоответствие между поведением API и спецификацией;
• опечатки или неточности в описаниях;
• отсутствующие примеры или документацию.

Процесс контрибьютинга

1. Создайте задачу с описанием проблемы.
2. Следуйте руководству в CONTRIBUTING.md.

Примечание: Из-за того, что эти спецификации используются во всей экосистеме GitVerse, мы не принимаем прямые запросы на слияние, изменяющие контракт API. Этот репозиторий синхронизируется с описаниями, используемыми для валидации запросов API GitVerse.

Лицензия

Этот проект лицензирован по лицензии MIT. Подробнее см. в файле LICENSE.

Контакты

1. Документация: GitVerse Public API Docs.
2. Поддержка: support@gitverse.ru.
3. Сообщения о проблемах: Задачи.