Download the PHP package euroglas/eurorest without Composer
On this page you can find all versions of the php package euroglas/eurorest. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download euroglas/eurorest
More information about euroglas/eurorest
Files in euroglas/eurorest
Package eurorest
Short Description Servidor REST para EUROGLAS
License MIT
Homepage http://euroglas.net
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package eurorest
EUROGLAS rest (eurorest)
Servidor REST para EUROGLAS
Modulo base (CORE) para los servidores REST de EUROGLAS.
Define:
- Manejador de rutas URL mediante AltoRouter
- Una interfaz para los modulos que se van a implementar
- Una interfaz para los modulos que validan el acceso (auth)
Archivos
eurorest
├───src
│ ├───auth.php
│ ├───authInterface.php
│ ├───restModuleInterface.php
│ ├───restServer.php
│ └───home
│ └─── index.php
├───.gitignore
├───composer.json
├───index.php
├───iniciaServidorDePruebas.php
├───servidor.ini
├───LICENSE
└───README.mdDirectorio src
Contiene los archivo que implementan el proyecto
Interfaces
- authInterface | Validacion de los usuarios
- restModuleInterface | Modulos REST
Clases
- auth | Clase abstracta como base para Clases de Usuarios
- restServer | Implementación del servidor REST
Directorio src/home
Contiene la pagina que se muestra cuando se accesa a la URL base / que informa al usuario que se esta accediendo a una API, no a una pagina regular.
Directorio Raiz
Contiene los archivos para pruebas del modulo.
| Archivo | Descripcion |
|---|---|
| .gitIgnore | blah |
| composer.json | Manejo de requerimientos |
| index.php | Implementacion del servidor de pruebas |
| servidor.ini | Configuracion del servidor |
| iniciaServidorDePruebas.bat | Script para arrancar el servidor usando el servidor interno de PHP |
| LICENSE | Licencia de uso de este paquete |
| README .md | éste archivo |
Configuración
| Llave | Explicación |
|---|---|
| ServerName="" | Nombre del servidor |
| ModoDebug = 1 | Habilita el modo de desarrollo |
| SkipUserAuth = 1 | Permite iniciar sin usuarios, sin generar error |
| [Modulos] | Grupo de Modulos a habilitar (Vacio porque estamos en CORE) |
URLs
| Metodo | URL | Descripción |
|---|---|---|
| OPTIONS | [todas] | Devuelve los metodos aceptados por el servidor |
| GET | / | Raiz (imprime contenido de HOME) |
| GET | /ping | Prueba rápida para saber si el servidor esta funcionando |
URLs para desarrollo
Estas URLs (excepto la primera) estarán disponibles SOLO cuando el servidor se encuentra en modo de desarrollo (ModoDebug=1).
| Metodo | URL | Descripción |
|---|---|---|
| GET | /debug | Consulta si el servidor esta en modo de desarrollo |
| GET | /debug/config | Muestra el contenido del archivo de configuración (ya parseado) |
| GET | /debug/serverName | Muestra el nombre del servidor (ServerName) |
| GET | /debug/modulos | Muestra lista de modulos habilitados |
| GET | /debug/permisos | Lista de permisos definidos por cada modulo |
| GET | /debug/urls | Lista de URLs definidas por cada modulo |
| GET | /debug/authProvider | Nombre del modulo registrado para validar usuarios y entregar el Token |
#
Uso del servidor REST
Para crear un servidor que use este proyecto para servir URLs REST
- Instala composer en tu ambiente de desarrollo
- Crea un directorio para tu proyecto
- Crea un archivo
composer.jsonpara definir los requerimientos -
Agrega este proyecto como requerimiento de tu servidor
- Ejecuta composer para instalar las dependencias (esto va a generar el archivo
composer.locky el directoriovendor)
Si quieres hacer uso de la utileria de autocarga de clases de composer, incluye esto en tu script php (index.php):
Redirigir las solicitudes de URLs a tu aplicación
Necesitamos que todas las solicitudes de ubicaciones no-existentes, sean procesadas por tu aplicacion (para que sean interpretadas como URLs del servidor Rest).
Si estas usando APACHE (.htaccess):
Si estas usando Nginx (nginx.conf):
Implementacion de modulos
Hay varios detalles que debes tener presentes a la hora de hacer tu modulo, y no pierdas incontables horas (y maldiciendo al autor de éste sistema) tratando de entender porque no funcionan las cosas.
Rutas y nombres
El sistema esta basado en el autoloader de composer (que a su vez sigue las especificaciones de PSR4), esto significa que:
Usa src
Los archivos que implementan tu modulo, deberán estar dentro del directorio src de tu proyecto.
El nombre del archivo importa
Para que la clase que implementa tu modulo, sea accesible al autoloader, el archivo se debe llamar IGUAL que la clase. Y esto es esctricto, respeta minusculas y mayuscular.
La clase class ejemploConCamel debe estar en el archivo ejemploConCamel.php
Espacio de nombres
Supongo que cualquier espacio de nombres es tan valido como otro, pero para evitar sorpresas, usa el espacio de nombres de EUROGLAS.
Herencia de tus mayores
Las clases que implementan los submodulos, deben implementar la interfaz restModuleInterface
Accesibilidad de las funciones
Las funciones que implementan la funcionalidad de las URLs (los callback), deben poder ser llamados desde el servidor, por lo que necesitan ser funciones publicas.
#
Implementacion de modulos de usuario (auth)
Los modulos que proveen los token de acceso, a cambio de algo de informacion, los llamamos Modulos de Acceso de Usuarios.
Siguen todas las caracteristicas de los modulos normales, EXCEPTO que deben heredar de la clase abstracta auth.
La clase abstracta auth, implementa tanto restModuleInterface como authInterface. Y proporciona algunas implementaciones default para algunas de las funciones.
Nota Cuando implementes un modulo auth, ten en cuenta que un servidor solo puede implementar un metodo de authenticacion (por ahora). Asegurate que tu modulo esta habilitado en la configuracion, y comprueba que esta listado como validador de usuarios, usando la url /debug/authProvider
