Git Product home page Git Product logo

armandolazarte / automatic-api-rest Goto Github PK

View Code? Open in Web Editor NEW

This project forked from geekytheory/automatic-api-rest

0.0 2.0 0.0 3.41 MB

Automatic API Rest is an Open Source Tool to provide you a full API Rest of your Data Base. You can get information externally of your Data Base to interact with your Apps. Automatic API Rest let you to build a JSON and XML trees of your Data Base. You can choose which tables are public and which are private to keep your secret information secure.

Home Page: http://automaticapirest.info

automatic-api-rest's Introduction

Automatic Api Rest

 

 

Automatic API Rest nace de la necesidad de gestionar los datos entre distintas plataformas de manera sencilla. Una de las cosas que más pereza me daba a la hora de crear una base de datos es tener que crear todas las clases y funciones (Normalmente en PHP) para dar servicio externo (Android, iOS, Python,etc) a la base de datos.

¿Qué es?

Automatic API Rest es una herramienta Open Source bajo licencia Apache 2.0 que te permite crear una completa API de tu base de datos MySQL (Por ahora sólo tiene soporte para MySQL o MariaDB). Automatic API Rest proporciona una red automática de enlaces proporcionándote la información en formato JSON o XML (No implementado todavía).  Mediante un panel de control se podrá escoger qué tablas o campos quieres compartir con tus aplicaciones externamente y cuáles no.

Automatic API Rest

Proyecto Open Source

Automatic Api Rest es un proyecto Open Source, todo el mundo es bienvenido a colaborar en él. Si queréis colaborar, enviarme un mail, o enviar directamente vuestros Pull Request.

github-logo

 

Instalación

A continuación se describen los pasos a seguir para la instalación:

Guía de usuario

Una vez que hemos descargado he instalado Automatic Api Rest, vamos a ir a la dirección del proyecto http://tudominio.com/AutomaticaApiRest. Nos encontraremos con la siguiente pantalla:

Captura1

 

Aquí tenemos que introducir nuestro usuario y contraseña que hemos establecido en el archivo config.php. Por defecto el usuario y contraseña es admin.

Una vez que hemos entrado al panel de administración de Automatic API Rest, observamos una pantalla como esta:

Captura2

Para mostrar un ejemplo, hemos apuntado a la base de datos por defecto de WordPress. Para explicar qué es cada cosa vamos a ir por bloques.

Navegador

Captura3
  • Home: Enlace al inicio del panel de control.
  • Documentation: Documentación del proyecto.
  • Black List: Gestión de las tablas privadas.
  • GitHub: Enlace al proyecto en GitHub
  • Close: Cierre de la sesión.

Gestión de Tablas

Captura4

 

  • Table Name: Nombre de la tabla de la base de datos.
  • API Link: Dirección de la API donde vamos a consultar todos los datos en formato JSON de la tabla.
  • Items: Número de Items que tiene la tabla.
  • Show Table: Mostrar una tabla con los datos de la tabla seleccionada
  • Privacity: Esta casilla muestra si la tabla es pública o privada, en caso de que sea privada el enlace no funcionará.
Si pulsamos sobre cualquier tabla de la base de datos, nos dirigiremos a otra tabla con los campos de la base de datos

Gestión de campos

Captura5
  • Column: Nombre del campo de la tabla seleccionada
  • API Link: Enlace que genera un JSON con toda la información del campo encapsulado.
  • Show Table: Ver una tabla con los datos del campo seleccionado.
  • Select: Consulta personalizada (Ver siguiente punto).
  • Privacity: Privacidad del campo

 Consulta Personalizada

Si seleccionamos la casilla select de algún campo, nos aparecerá la siguiente tabla de configuración:

Captura6Observamos que podemos personalizar la consulta de datos, si por ejemplo sólo nos interesa el ID y el nombre de los últimos 5 registros de la tabla users generamos un enlace que exactamente nos ofrezca eso.

Black List

Captura7

La Black List muestra todos las tablas y columnas que no permitimos obtener los datos. Desde esta misma tabla podemos eliminar los registros de la Black List.

Hello World en PHP

Un ejemplo de uso de Automatic API Rest en PHP es el siguiente:
<?php
//Get JSON from Automatic Api Rest
$json = file_get_contents("API LINK");
//Decode JSON
$json = json_decode($json);

for($i=0;$i<count($json);$i++){ echo $json[$i]->campo; }

En este ejemplo obtenemos un JSON de la API LINK que queramos. una vez obtenido el JSON lo codificamos y mostramos aquellos campos que nos interesa.

Líneas Futuras

Los siguientes puntos son las tareas que quedan por hacer para que el proyecto este finalizado del todo.
  • Implementar salida de datos con XML
  • Crear documentación para cada plataforma.
  • Implementar una seguridad más robusta y fiable.
  • Codificar los datos de salida.
  • Dar soporte a consultas complejas, WHERE, INNER, etc.

Enlaces de Interés

Y esto es todo espero que os haya gustado el proyecto, a la vez os animo a que colaboréis con el en lo que podáis.

automatic-api-rest's People

Contributors

alejandroesquiva avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.