caicedo1089/web-rest-api

Web API Rest es un micro framework que muestra la creación y uso de un API Rest.

Maintainers

Details

github.com/caicedo1089/web-rest-api

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

Language:JavaScript

1.0.0 2018-03-07 02:50 UTC

Requires

MIT 42680ceb38514e82d1a100b8792a76a5de25af83

  • Pedro Caicedo <caicedo1089.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-05-17 00:31:10 UTC

README

Web API Rest es un micro framework que muestra la creación y uso de un API Rest. Además tiene un pequeño Auth que permite la autenticación de usuarios. Está basado en Eloquent para el manejo de los modelos, PHP Router para el manejo de las rutas y PHP Dotenv para manejar las configuraciones.

La estructura de carpeta es muy simple, cómo se muestra a continuación:

  • app/ Almacena la API y la Web, y una carpeta core donde se almacena las clases bases de los modelos y controladores de la API.
  • config/ Almacena todas las configuraciones principales.
  • public/ Almacena todos los archivos assets que serán publicos, en este caso está el Fornt End, realizado en ExtJS 4.2.1.

Demostración

Demostración

Instalación

  • Clone el proyecto.
  • Ubiquese dentro de la carpeta y ejecute el siguiente comando composer:
composer install
  • En el proyecto está el archivo users.sql, importelo en su BD, probado solamente en BD MySQL.
  • En el archivo .env agrege los datos de conexión de su BD.
  • Para terminar levantaremos un servidor http para probar el proyecto, para esto ejecute el comando:
php -S localhost:8000

Al abrir en el navegador(browser) nuestra web en localhost:8000 podemos acceder al proyecto. En el /api podemos acceder a la API y en /web podemos acceder a la web.

API Access Points

Este proyecto sólo tiene estos dos end points:

###AUTH:

Manejo de la autenticación.

  • POST /api/auth/login
//JSON Request
{
    "login": "correo@dominio.com",
    "password": "123456"
}

//JSON Response - 200
{
    "data": {
        "id": 29,
        "full_name": "Pedro Caicedo",
        "username": "pcaicedo",
        "email": "info@pcaicedo.com",
        "remember_token": null,
        "created_at": "-0001-11-30 00:00:00",
        "updated_at": "-0001-11-30 00:00:00",
        "deleted_at": null
    }
}
  • POST /api/auth/register
//JSON Request
{
    "full_name": "Pedro Caicedo",
    "username": "caicedo1089",
    "email": "correo@dominio.com",
    "password": "123456"
}

//JSON Response - 200
{
    "data": {
        "id": 31
    }
}
  • GET /api/auth/logout
//JSON Request - No aplica

//JSON Response - 200
{
    "data": {
        "id": 29
    }
}

###USERS:

CRUD de los usuarios del sistema.

  • GET /api/users/
//JSON Request

?filter=<Filtra por nombre, username o correo>

//JSON Response - 200
{
    "data": [
        {
            "id": 28,
            "full_name": "José Caicedo",
            "username": "caicer",
            "email": "caicer",
            "remember_token": null,
            "created_at": "2018-03-05 06:01:48",
            "updated_at": "-0001-11-30 00:00:00",
            "deleted_at": null
        }
    ]
}
  • POST /api/users/
//JSON Request
{
    "full_name": "Pedro Caicedo",
    "username": "caicedo1089",
    "email": "correo@dominio.com",
    "password": "123456"
}

//JSON Response - 200
{
    "data": {
        "id": 31
    }
}
  • PUT /api/users/<id_user> Todos los parametros de la solicitud (request) son opcionales, ea decir si sólo queremos actualizar el nombre sólo enviamos el parametro full_name en el JSON.
//JSON Request
{
    "full_name": "Otro Nombre", 
    "username": "caicedo1089_CO",
    "email": "correo@dominio.com.co",
    "password": "1234567"
}

//JSON Response - 200
{
    "data": {
        "id": 31
    }
}
  • DELETE /api/users/<id_user>
//JSON Request - No aplica

//JSON Response - 200
{
    "data": {
        "id": 31
    }
}

Créditos

Licencia