Рефакторинг && Архитектура/Контроллеры
- Замена модели "Сайт" на "Проект" - Описание контроллеров
This commit is contained in:
parent
d405591d9f
commit
2e6b359760
GPG Key ID:
C122E85DD49E6B30
|
|
@ -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
|
||||
|
|
@ -15,19 +15,19 @@
|
|||
---
|
||||
- **Публичный | В формат БД | Строка** - Преобразовывает модель в формат, необходимый для записи в базу данных
|
||||
- **Публичный | В Json | Строка** - Преобразовывает модель в *.json*
|
||||
## Сайт
|
||||
## Проект
|
||||
---
|
||||
>[!Сайт]
|
||||
>Реализация абстрактного класса виджета для описания сайтов ORUDO
|
||||
>[!Проект]
|
||||
>Реализация абстрактного класса виджета для описания проектов ORUDO
|
||||
### Поля
|
||||
---
|
||||
- **Ссылка** - Ссылка на сайт | Строка
|
||||
- **Редирект** - Должна ли быть кнопка для перехода на сайт | Булево
|
||||
- **Изображение** - Ссылка на изображение с логотипом сайта | Строка
|
||||
- **Ссылка** - Ссылка на проект | Строка
|
||||
- **Редирект** - Должна ли быть кнопка для перехода на проект | Булево
|
||||
- **Изображение** - Ссылка на изображение с логотипом проекта | Строка
|
||||
### Yaml представление
|
||||
---
|
||||
```yaml
|
||||
Sites:
|
||||
Projects:
|
||||
id:
|
||||
name: ""
|
||||
desk: ""
|
||||
|
|
@ -54,7 +54,7 @@ Sites:
|
|||
>Реализация абстрактного класса виджета для описания внешних ресурсов ORUDO
|
||||
### Поля
|
||||
---
|
||||
- **Ссылка** - Ссылка на сайт | Строка
|
||||
- **Ссылка** - Ссылка на Проект | Строка
|
||||
- **Изображение** - Ссылка на изображение с аватаром ресурса | Строка
|
||||
- **Иконка кнопки** - Ссылка на изображение с иконкой ресурса | Строка
|
||||
### Yaml представление
|
||||
|
|
|
|||
|
|
@ -12,13 +12,12 @@
|
|||
---
|
||||
- **Приватный | Добавить виджет | Целое число | Абстрактный** - Добавляет виджет в базу данных, возвращает id
|
||||
- **Приватный | Получить виджет | Виджет | Абстрактный** - Возвращает данные из базы данных по id
|
||||
- **Публичный | Получить размер репозитория | Целое число | Абстрактный** - Возвращает размер репозитория
|
||||
## Репозиторий сайтов
|
||||
- **Публичный | Получить список репозитория | Список целых чисел | Абстрактный** - Возвращает список ключей репозитория
|
||||
## Репозиторий проектов
|
||||
---
|
||||
>[!Репозиторий сайтов]
|
||||
>Реализации абстрактного класса репозитория для управления сайтами
|
||||
|
||||
>[!Репозиторий проектов]
|
||||
>Реализации абстрактного класса репозитория для управления проектами
|
||||
## Репозиторий соц. сетей
|
||||
---
|
||||
>[!Репозиторий сайтов]
|
||||
>[!Репозиторий cоц.сетей]
|
||||
>Реализации абстрактного класса репозитория для управления соц. сетями
|
||||
|
|
@ -18,14 +18,14 @@
|
|||
- [[Утилиты#Redis|Управление ДБ Redis]]
|
||||
- [[Утилиты#Статические ф-ии|Статические ф-ии]]
|
||||
- **[[Репозитории]]** *(Модули для получения доступа к данным БД)*
|
||||
- [[Репозитории#Репозиторий сайтов|Сайты]]
|
||||
- [[Репозитории#Репозиторий проектов|Проекты]]
|
||||
- [[Репозитории#Репозиторий соц. сетей|Соц. сети]]
|
||||
- **Контроллеры** *(Модули управления программным интерфейсом)*
|
||||
- Сайты
|
||||
- **[[Контроллеры]]** *(Модули управления программным интерфейсом)*
|
||||
- [[Контроллеры#Проекты|Проекты]]
|
||||
- Соц. сети
|
||||
- **[[Модели]]** *(Структуры данных)*
|
||||
- [[Модели#Виджет (Абстрактный)|Виджет (Абстракция)]]
|
||||
- [[Модели#Сайт|Сайт]]
|
||||
- [[Модели#Проект|Проект]]
|
||||
- [[Модели#Соц. сеть|Соц. сеть]]
|
||||
## Структура FrontEnd
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Сайты
|
||||
# Проекты
|
||||
***
|
||||
> Описание виджетов сайтов хостинга ORUDO
|
||||
> Описание виджетов проектов хостинга ORUDO
|
||||
## CDN
|
||||
---
|
||||
>[!CDN]
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# Соц. сети
|
||||
---
|
||||
> Описание ресурсов ORUDO на других платформах
|
||||
> Описание виджетов ресурсов ORUDO на других платформах
|
||||
## Discord
|
||||
---
|
||||
>[!Discord]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
## название_проекта
|
||||
---
|
||||
>[!название_проекта]
|
||||
>описание_проекта
|
||||
|
||||
**Ccылка:**
|
||||
**Редирект:** Да / Нет
|
||||
**Изображение:**
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
## название_сайта
|
||||
---
|
||||
>[!название_сайта]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
**Редирект:** Да / Нет
|
||||
**Изображение:**
|
||||
Loading…
Reference in New Issue