diff --git a/.idea/misc.xml b/.idea/misc.xml index 9a2891c..eec4703 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,4 +1,7 @@ - + + + \ No newline at end of file diff --git a/.idea/server.iml b/.idea/server.iml index a3ed408..85b1044 100644 --- a/.idea/server.iml +++ b/.idea/server.iml @@ -3,8 +3,9 @@ + - + \ No newline at end of file diff --git a/docs/API.md b/docs/API.md index e69de29..36e7029 100644 --- a/docs/API.md +++ b/docs/API.md @@ -0,0 +1,65 @@ +# Топология API + +Последняя версия API: `1.0`\ +Формат запроса: `https://<адрес-сервера>/api/method/<имя-API-метода>?<параметры>`: +- Метод всегда `GET` +- `<адрес-сервера>`: `mml.anidev.ru` +- `<имя-API-метода>`: Имя метода API. Например, `auth.register` +- `<параметры>`: Параметры запроса. Например, `v=1.0&login=example&password=example` + +## Auth + +WIP\ +В будущем будет добавлена авторизация. + +## Users + +WIP\ +В будущем будет добавлена работа с пользователями. + +## Modpacks + +### `modpacks.create` + +Загрузка модпака на сервер. + +.... + +### `modpacks.update` + +Обновление информации о модпаке. + +.... + +### `modpacks.get` + +Получение информации о модпаке. + +Аргументы: + +| Название | Тип | Описание | Доступные значения | +|--------------|-------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| `modpack_id` | `int` | ID модпака | | +| `fields` | `str` | (Опционально)
Поля, которые нужно вернуть. | - `name`
- `description`
- `version`
- `author`
- `mods`
- `mods_count`
- `created_at`
- `updated_at` | +| `v` | `str` | Версия API | | + + +Возвращает (JSON): + +| Название | Тип | Описание | Пример | +|---------------|--------|-----------------------------------|------------------------------| +| `name` | `str` | Название модпака | `Example Modpack` | +| `description` | `str` | Описание модпака | `This is an example modpack` | +| `version` | `str` | Версия модпака (может быть любым) | `Super Stabe v1.1` | +| `author` | `str` | Автор модпака | `example` | +| `mods` | `list` | Список модов в модпаке | `["mod1", "mod2", "mod3"]` | +| `mods_count` | `int` | Количество модов в модпаке | `3` | +| `created_at` | `str` | Дата создания модпака | `2025-01-01T00:00:00` | +| `updated_at` | `str` | Дата последнего обновления | `2025-04-01T00:00:00` | + +### `modpacks.delete` + +Удаление модпака. + +.... +