Общее описание

Введение

API Docs - сборник документации с основной информацией об игровой платформе, описанием сервисов MAPI, Core- и OpenAPI, SW mirrors base microservice, LangSphere microservice.

Документ предназначен для разработчиков, интеграторов и всех заинтересованных сторон, которые хотят глубже понять архитектуру и функциональность платформы.

Цели документации

• Понимание архитектуры проекта

• Обеспечение ясности: предоставление четких и понятных описаний API для более легкого понимания разработчиками возможностей интеграции с платформой

• Упрощение интеграции: с помощью спецификаций предлагается стандартизировать интерфейсы для взаимодействия с различными компонентами платформы.

Структура документации

Основная информация об игровой платформе
общая информация об игровой платформе, включая ее архитектуру, основные функции, ключевые модули, предоставляемые сервисы

Reference MAPI
спецификации сервиса для отправки SMS и email

Reference CoreAPI
спецификации CoreAPI, внутреннем API платформы

Reference OpenAPI
спецификации OpenAPI, которые описывают доступные методы запросов и форматы данных, используемые в API

Reference SW Mirrors Base microservice
описание базовых микросервисных маршрутов SW mirrors

Reference LangSphere microservice
документация по API LangSphere.