Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 3.76 KB

README.md

File metadata and controls

81 lines (58 loc) · 3.76 KB
Raw

Automatic API REST (Beta) -

Automatic API REST is an Open Source Tool to create a full REST API of your Data Base in seconds. AAR uses the native functions of MySQL to abstract your data base and provide the information in different formats (JSON available). Automatic API REST let you to build a JSON and XML tree of your Data Base. You can choose which tables are public and which are private to keep your secret information secure.

Automatic API Rest works as a bridge to interact with all programing languages which can read a JSON and XML format, facilitating the communication machine-to-machine (M2M). Read from JAVA, c++, python (...) all the information from you data base to implement your apps.

Visit Automatic API REST to view our demo.

View DEMO | View Features | Installation Instructions | User Guide | Documentation | TO-DO | Links

Features

  • Creation of a powerful REST API of your MySQL DB in Seconds.
  • Management of the API in situ, it is not neccesary an extra database.
  • Private tables and columns.
  • REST-based URIs format.
  • Custom queries.

Dependencies

  • PHP5
  • MySQL
  • Apache or Nginx

Installation

  1. Download the source or clone the repository in the root folder of your project.
  2. Place it in /var/www/YourWebPage/ (for Apache).
  3. Open the fileconfig.php  and complete all the fields with the server credencials.
  4. Replace the file .htaccess in the root folder of your project if your are using Apache. In case you are using Nginx, please follow the intructions attached in /Server-Configuration/ folder.
  5. Go to http://domain.com/Automatic-API-REST

Note: If you have troubles with the privacy system, please allow access to xml folder..

Note 2: If you have troubles in localhost with apache, please see this issue.

Hello World (GET From PHP)

<?php
    //Get JSON from Automatic Api Rest
    $apiLink = "http://localhost/api/get/city/";
    $json = file_get_contents($apiLink);
    //Decode JSON
    $json = json_decode($json);
    //Print
    for($i=0;$i<count($json);$i++){
        echo $json[$i].ID;
    }

TO-DO

  • Implement XML Format
  • Documentation for all the platforms
  • Security
  • Complex query

Links

License

Copyright 2014 GeekyTheory (Alejandro Esquiva)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.