task

src/main/webapp/content/md/README.md

@@ -5,15 +5,15 @@
 
 ##  Файлообменник
 ###  Общие требования
-для доступа к размещенным ресурсам должен ограничиваться доступ
+- для доступа к размещенным ресурсам должен ограничиваться доступ
-файлы размещаются на сервере в папке /share
+- файлы размещаются на сервере в папке /share
-файлы могут добавляться на сервер только из приложения (добавленные нарпямую файлы должны отдельно администрироваться, для создания записей в базе данных контента)
+- файлы могут добавляться на сервер только из приложения (добавленные нарпямую файлы должны отдельно администрироваться, для создания записей в базе данных контента)
-сведения о файлах, правах пользователей на эти файлы хранятся в postgres
+- сведения о файлах, правах пользователей на эти файлы хранятся в postgres
-файлы могут размещаться по различным каталогам
+- файлы могут размещаться по различным каталогам
-
-### Возможности пользователя:
 
+### Возможности пользователя
 __Каталоги:__
+---
 - создание каталогов
 - удаление каталогов
 - просмотр содержимого каталогов
@@ -23,6 +23,7 @@ __Каталоги:__
 - загрузка каталога со всем содержимым  с компьютера пользователя на сервер
 
 __Файлы:__
+---
 - загрузка файлов на сервер
 - создание файлов
 - удаление файлов
@@ -35,7 +36,29 @@ __Файлы:__
 - скачивание файлов
 
 ### Особенности реализации
+    файлообменник реализуется как микросервис, имеющий внешний api,
+    для доступа к сервису разрабатывается:
+    - web-интерфейс,
+    - telegram.bot (альтернатива мобильному приложению).
+
+### api файлообменника storage.molokoin.ru/api
+---
+    storage.molokoin.ru/api/cat/from/base:
+    - Возвращает список каталогов размещенных на сервере и зарегистрированных в базе данных
+---
+    storage.molokoin.ru/api/cat/from/hdd:
+    - Возвращает общий список каталогов размещенных на сервере
+---
+    storage.molokoin.ru/api/files/from/base:
+    - возвращает список файлов размещенных на сервере, зарегистрированных в базе
+---
+    storage.molokoin.ru/api/files/from/hdd:
+    - Возвращает общий список файлов размещенных на сервере
+---
+
+---
     
+    -получить перечень файлов в директории
 
 ##  Заметки
 ###  Общие требования