diff --git a/Архитектура/Контроллеры.md b/Архитектура/Контроллеры.md new file mode 100644 index 0000000..d50a06a --- /dev/null +++ b/Архитектура/Контроллеры.md @@ -0,0 +1,38 @@ +# Контроллеры +*** +## Проекты +--- +**URL:** ORUDO.RU/API/PROJECTS/ +### Методы: +--- +- **GET/{ID}** - Возвращает модель проекта + - *Метод запроса:* GET + - *Возврат:* [[Модели#Проект|Модель проекта]] + - *Статусы:* 200 / 404 / 403 + - *Параметры:* + - **{ID}** - Ключ нужной модели в базе данных + - **?API_KEY** - Ключ доступа к API +- **GET/list** - Возвращает список ключей проектов + - *Метод запроса:* GET + - *Возврат:* List\[Integer] + - *Статусы:* 200 / 403 + - *Параметры:* + - **?API_KEY** - Ключ доступа к API +## Соц. сети +--- +**URL:** ORUDO.RU/API/SOCIALS/ +### Методы: +--- +- **GET/{ID}** - Возвращает модель cоц. сети + - *Метод запроса:* GET + - *Возврат:* [[Модели#Соц. сеть|Модель соц. сети]] + - *Статусы:* 200 / 404 / 403 + - *Параметры:* + - **{ID}** - Ключ нужной модели в базе данных + - **?API_KEY** - Ключ доступа к API +- **GET/list** - Возвращает список ключей соц. сетей + - *Метод запроса:* GET + - *Возврат:* List\[Integer] + - *Статусы:* 200 / 403 + - *Параметры:* + - **?API_KEY** - Ключ доступа к API \ No newline at end of file diff --git a/Архитектура/Модели.md b/Архитектура/Модели.md index 1e9086c..d562f27 100644 --- a/Архитектура/Модели.md +++ b/Архитектура/Модели.md @@ -15,19 +15,19 @@ --- - **Публичный | В формат БД | Строка** - Преобразовывает модель в формат, необходимый для записи в базу данных - **Публичный | В Json | Строка** - Преобразовывает модель в *.json* -## Сайт +## Проект --- ->[!Сайт] ->Реализация абстрактного класса виджета для описания сайтов ORUDO +>[!Проект] +>Реализация абстрактного класса виджета для описания проектов ORUDO ### Поля --- -- **Ссылка** - Ссылка на сайт | Строка -- **Редирект** - Должна ли быть кнопка для перехода на сайт | Булево -- **Изображение** - Ссылка на изображение с логотипом сайта | Строка +- **Ссылка** - Ссылка на проект | Строка +- **Редирект** - Должна ли быть кнопка для перехода на проект | Булево +- **Изображение** - Ссылка на изображение с логотипом проекта | Строка ### Yaml представление --- ```yaml -Sites: +Projects: id: name: "" desk: "" @@ -54,7 +54,7 @@ Sites: >Реализация абстрактного класса виджета для описания внешних ресурсов ORUDO ### Поля --- -- **Ссылка** - Ссылка на сайт | Строка +- **Ссылка** - Ссылка на Проект | Строка - **Изображение** - Ссылка на изображение с аватаром ресурса | Строка - **Иконка кнопки** - Ссылка на изображение с иконкой ресурса | Строка ### Yaml представление diff --git a/Архитектура/Репозитории.md b/Архитектура/Репозитории.md index bd5582b..204f533 100644 --- a/Архитектура/Репозитории.md +++ b/Архитектура/Репозитории.md @@ -12,13 +12,12 @@ --- - **Приватный | Добавить виджет | Целое число | Абстрактный** - Добавляет виджет в базу данных, возвращает id - **Приватный | Получить виджет | Виджет | Абстрактный** - Возвращает данные из базы данных по id -- **Публичный | Получить размер репозитория | Целое число | Абстрактный** - Возвращает размер репозитория -## Репозиторий сайтов +- **Публичный | Получить список репозитория | Список целых чисел | Абстрактный** - Возвращает список ключей репозитория +## Репозиторий проектов --- ->[!Репозиторий сайтов] ->Реализации абстрактного класса репозитория для управления сайтами - +>[!Репозиторий проектов] +>Реализации абстрактного класса репозитория для управления проектами ## Репозиторий соц. сетей --- ->[!Репозиторий сайтов] ->Реализации абстрактного класса репозитория для управления соц. сетями +>[!Репозиторий cоц.сетей] +>Реализации абстрактного класса репозитория для управления соц. сетями \ No newline at end of file diff --git a/Архитектура/Структура проекта.md b/Архитектура/Структура проекта.md index 6a4e16b..80e68bc 100644 --- a/Архитектура/Структура проекта.md +++ b/Архитектура/Структура проекта.md @@ -18,14 +18,14 @@ - [[Утилиты#Redis|Управление ДБ Redis]] - [[Утилиты#Статические ф-ии|Статические ф-ии]] - **[[Репозитории]]** *(Модули для получения доступа к данным БД)* - - [[Репозитории#Репозиторий сайтов|Сайты]] + - [[Репозитории#Репозиторий проектов|Проекты]] - [[Репозитории#Репозиторий соц. сетей|Соц. сети]] -- **Контроллеры** *(Модули управления программным интерфейсом)* - - Сайты +- **[[Контроллеры]]** *(Модули управления программным интерфейсом)* + - [[Контроллеры#Проекты|Проекты]] - Соц. сети - **[[Модели]]** *(Структуры данных)* - [[Модели#Виджет (Абстрактный)|Виджет (Абстракция)]] - - [[Модели#Сайт|Сайт]] + - [[Модели#Проект|Проект]] - [[Модели#Соц. сеть|Соц. сеть]] ## Структура FrontEnd --- diff --git a/Копирайтинг/Сайты.md b/Копирайтинг/Проекты.md similarity index 83% rename from Копирайтинг/Сайты.md rename to Копирайтинг/Проекты.md index 8786a18..7230f15 100644 --- a/Копирайтинг/Сайты.md +++ b/Копирайтинг/Проекты.md @@ -1,6 +1,6 @@ -# Сайты +# Проекты *** -> Описание виджетов сайтов хостинга ORUDO +> Описание виджетов проектов хостинга ORUDO ## CDN --- >[!CDN] diff --git a/Копирайтинг/Соц. сети.md b/Копирайтинг/Соц. сети.md index 4237d62..e35d441 100644 --- a/Копирайтинг/Соц. сети.md +++ b/Копирайтинг/Соц. сети.md @@ -1,6 +1,6 @@ # Соц. сети --- -> Описание ресурсов ORUDO на других платформах +> Описание виджетов ресурсов ORUDO на других платформах ## Discord --- >[!Discord] diff --git a/Шаблоны/Проект.md b/Шаблоны/Проект.md new file mode 100644 index 0000000..7564c49 --- /dev/null +++ b/Шаблоны/Проект.md @@ -0,0 +1,8 @@ +## название_проекта +--- +>[!название_проекта] +>описание_проекта + +**Ccылка:** +**Редирект:** Да / Нет +**Изображение:** \ No newline at end of file diff --git a/Шаблоны/Сайт.md b/Шаблоны/Сайт.md deleted file mode 100644 index 2198940..0000000 --- a/Шаблоны/Сайт.md +++ /dev/null @@ -1,8 +0,0 @@ -## название_сайта ---- ->[!название_сайта] ->описание_сайта - -**Ccылка:** -**Редирект:** Да / Нет -**Изображение:** \ No newline at end of file