refs #631 - More API improvements
parent
965795c416
commit
80ba5d220e
|
@ -58,7 +58,7 @@ with open("swagger.yaml", "r") as file:
|
|||
|
||||
# Así cambiamos el nombre de la página (por defecto, es 'Flasgger'):
|
||||
swagger_config = Swagger.DEFAULT_CONFIG
|
||||
swagger_config['title'] = 'OgRepository API'
|
||||
swagger_config['title'] = 'ogRepository API'
|
||||
|
||||
swagger = Swagger(app, template=swagger_template)
|
||||
|
||||
|
|
|
@ -1,44 +1,10 @@
|
|||
swagger: "2.0"
|
||||
info:
|
||||
title: "OgRepository API"
|
||||
title: "ogRepository API"
|
||||
version: "1.0"
|
||||
description: |
|
||||
---
|
||||
|
||||
**API de ogRepository, programada en Flask**.
|
||||
|
||||
Responde a peticiones HTTP mediante endpoints, que a su vez ejecutan los scripts de Python 3 almacenados en ogRepository. En el entorno real, estas peticiones HTTP se enviarán desde ogCore.
|
||||
En la mayoría de los casos, transforma los parámetros recibidos para adaptarlos a los que es necesario enviar a los scripts (por ejemplo, a partir del ID de una imagen obtiene su nombre y su extensión).
|
||||
|
||||
---
|
||||
|
||||
Paquetes APT requeridos:
|
||||
- **uftp** (se puede instalar con "sudo DEBIAN_FRONTEND=noninteractive apt install uftp -y", para que no pida la ruta predeterminada, y se debe deshabilitar el servicio)
|
||||
- **udpcast** (se puede instalar con "sudo apt install ./udpcast_20230924_amd64.deb", apuntando al paquete)
|
||||
- **ctorrent** (se puede instalar con "sudo apt install ctorrent")
|
||||
- **bittorrent** (se puede instalar con "sudo apt install bittorrent", pero previamente hay que añadir un repositorio de Debian)
|
||||
- **bittornado** (se puede instalar con "sudo apt install bittornado", pero previamente hay que añadir un repositorio de Debian)
|
||||
- **wakeonlan** (se puede instalar con "sudo apt install wakeonlan")
|
||||
|
||||
Librerías Python requeridas:
|
||||
- **flask** (se puede instalar con "sudo apt install python3-flask")
|
||||
- **paramiko** (se puede instalar con "sudo apt install python3-paramiko")
|
||||
- **psutil** (se puede instalar con "sudo apt install python3-psutil")
|
||||
- **flasgger** (se puede instalar con "sudo apt install python3-flasgger")
|
||||
|
||||
Para que todos los endpoints de la API funcionen con la configuración actual deben existir los siguientes directorios:
|
||||
- **/opt/opengnsys/ogrepository/images/**
|
||||
- **/opt/opengnsys/ogrepository/images_trash/** (debe estar en la misma partición que el anterior, o tardarán mucho las eliminaciones y restauraciones)
|
||||
- **/opt/opengnsys/ogrepository/bin/** (aquí deben estar todos los scripts de Python, y el binario "udp-sender")
|
||||
- **/opt/opengnsys/ogrepository/api/** (aquí debe estar la API y el Swagger)
|
||||
- **/opt/opengnsys/ogrepository/etc/** (aquí se guardan los archivos "repoinfo.json" y "trashinfo.json")
|
||||
- **/opt/opengnsys/ogrepository/log/** (aquí se guardan los logs)
|
||||
|
||||
Y también debe existir el siguiente archivo:
|
||||
- **/opt/opengnsys/ogrepository/etc/ogAdmRepo.cfg** (de aquí pilla su IP y la de ogCore)
|
||||
|
||||
---
|
||||
|
||||
# -----------------------------------------------------------------------------------------------------------
|
||||
|
||||
# Esto hace que el Swagger se ordene por los tags (apartados), de la forma especificada:
|
||||
|
|
Loading…
Reference in New Issue