Add openapi API documentation (#294)

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Update README (#1)

* Update README

I completely redid the `README.md`. Now it's much easier to read and understand.

---------

Co-authored-by: cocool97 <34218602+cocool97@users.noreply.github.com>

* Improves documentation

* Delete server/config.db

* Update README.md

* Update README.md

* fix download in api docs

* add api docs to web

---------

Co-authored-by: Shadeov <144587546+shadeov@users.noreply.github.com>
Co-authored-by: nikk gitanes <tsynik@gmail.com>
This commit is contained in:
cocool97
2023-11-13 07:59:23 +01:00
committed by GitHub
parent aa061fd24c
commit b72c66d433
32 changed files with 5375 additions and 2024 deletions

View File

@@ -70,6 +70,7 @@ export default function AboutDialog() {
<LinkComponent name={t('ProjectSource')} link='https://github.com/YouROK/TorrServer' />
<LinkComponent name={t('Releases')} link='https://github.com/YouROK/TorrServer/releases' />
<LinkComponent name={t('NasReleases')} link='https://github.com/vladlenas' />
<LinkComponent name={t('ApiDocs')} link='swagger/index.html' />
</div>
</Section>
@@ -77,8 +78,8 @@ export default function AboutDialog() {
<span>{t('SpecialThanks')}</span>
<div>
<LinkComponent name='Daniel Shleifman' link='https://github.com/dancheskus' />
<LinkComponent name='Matt Joiner' link='https://github.com/anacrolix' />
<LinkComponent name='Daniel Shleifman' link='https://github.com/dancheskus' />
<LinkComponent name='nikk' link='https://github.com/tsynik' />
<LinkComponent name='kolsys' link='https://github.com/kolsys' />
<LinkComponent name='tw1cker' link='https://github.com/Nemiroff' />
@@ -86,7 +87,10 @@ export default function AboutDialog() {
<LinkComponent name='damiva' link='https://github.com/damiva' />
<LinkComponent name='Anton Potekhin' link='https://github.com/Anton111111' />
<LinkComponent name='FaintGhost' link='https://github.com/FaintGhost' />
<LinkComponent name='vladlenas' link='https://github.com/vladlenas' />
<LinkComponent name='TopperBG' link='https://github.com/TopperBG' />
<LinkComponent name='FaintGhost' link='https://github.com/FaintGhost' />
<LinkComponent name='lieranderl' link='https://github.com/lieranderl' />
<LinkComponent name='cocool97' link='https://github.com/cocool97' />
</div>
</Section>
</div>

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "Добавете торент",
"AddNewTorrent": "Добавете нов торент",
"ApiDocs": "Документация на API",
"B": "B",
"bps": "bps",
"Buffer": "Предварителен буфер / кеш",
@@ -66,6 +67,7 @@
"MB": "MB",
"Mbps": "Mbps",
"Name": "Име",
"NasReleases": "NAS Releases",
"NoTorrentsAdded": "Няма добавени торенти",
"Offline": "Извън линия",
"OK": "OK",
@@ -76,7 +78,6 @@
"Playlist": "Плейлист",
"Preload": "Предварително зареждане",
"ProjectSource": "GitHub на проекта",
"NasReleases": "NAS Releases GitHub",
"PWAGuide": {
"Header": "Инсталирайте приложение",
"Description": "Инсталирайте приложението на вашето устройство за лесен достъп до него по всяко време. Няма магазини за приложения. Няма сваляне.",

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "Add Torrent",
"AddNewTorrent": "Add new torrent",
"ApiDocs": "API Docs",
"B": "B",
"bps": "bps",
"Buffer": "Preload Buffer / Cache",
@@ -66,6 +67,7 @@
"MB": "MB",
"Mbps": "Mbps",
"Name": "Name",
"NasReleases": "NAS Releases",
"NoTorrentsAdded": "No torrents added",
"Offline": "Offline",
"OK": "OK",
@@ -76,7 +78,6 @@
"Playlist": "Playlist",
"Preload": "Preload",
"ProjectSource": "Project GitHub",
"NasReleases": "NAS Releases GitHub",
"PWAGuide": {
"Header": "Install application",
"Description": "Install the app on your device to easily access it anytime. No app store. No download.",

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "Добавить",
"AddNewTorrent": "Добавить новый торрент",
"ApiDocs": "Документация API",
"B": "Б",
"bps": "бит/c",
"Buffer": "Предзагрузка / Кеш",
@@ -66,6 +67,7 @@
"MB": "МБ",
"Mbps": "Мбит/c",
"Name": "Название",
"NasReleases": "Релизы для NAS",
"NoTorrentsAdded": "Нет торрентов",
"Offline": "Сервер недоступен",
"OK": "OK",
@@ -76,7 +78,6 @@
"Playlist": "Плейлист",
"Preload": "Предзагр.",
"ProjectSource": "GitHub проекта",
"NasReleases": "Релизы для NAS GitHub",
"PWAGuide": {
"Header": "Установить приложение",
"Description": "Установите приложение на ваше устройство для быстрого доступа в любой момент. Без AppStore. Без загрузки.",

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "Додати торент",
"AddNewTorrent": "Додати новий торент",
"ApiDocs": "Документація API",
"B": "Б",
"bps": "біт/c",
"Buffer": "Буфер",
@@ -66,6 +67,7 @@
"MB": "МБ",
"Mbps": "Мбіт/c",
"Name": "Назва",
"NasReleases": "Релізи для NAS",
"NoTorrentsAdded": "Немає торентів",
"Offline": "Сервер не доступний",
"OK": "OK",
@@ -76,7 +78,6 @@
"Playlist": "Плейлист",
"Preload": "Передзав.",
"ProjectSource": "Сайт проекту",
"NasReleases": "Релізи для NAS GitHub",
"PWAGuide": {
"Header": "Встановити додаток",
"Description": "Встановіть програму на свій пристрій, щоб легко отримати до неї доступ у будь-який час. Немає магазину додатків. Немає завантаження.",

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "添加种子",
"AddNewTorrent": "添加新种子",
"ApiDocs": "API 文档",
"B": "B",
"bps": "bps",
"Buffer": "预加载缓冲区/缓存",
@@ -66,6 +67,7 @@
"MB": "MB",
"Mbps": "Mbps",
"Name": "名称",
"NasReleases": "NAS 版本",
"NoTorrentsAdded": "没有添加种子",
"Offline": "离线",
"OK": "确定",
@@ -76,7 +78,6 @@
"Playlist": "播放列表",
"Preload": "预加载",
"ProjectSource": "项目GitHub",
"NasReleases": "NAS GitHub 版本",
"PWAGuide": {
"Header": "安装应用程序",
"Description": "将应用程序安装到您的设备上,以便随时方便地访问。无需应用商店、无需下载。",