Skip to main content
Version: 10.x

Installation

Apiato Application Installation#

Project Setup Via Composer#

If you already have php and composer installed on your computer (read requirements) you may create a new Apiato project using the command below:

composer create-project apiato/apiato my-api

The Apiato Installer#

Or, you may install the Apiato Installer as a global Composer dependency:

composer global require apiato/installer

Then create a new Apiato project using Apiato Installer:

apiato new my-api

Advantages of using Apiato Installer:

  • After your project installed, you will be asked to choose containers you want to install in your fresh project.
  • You can install the latest stable version (by default), or the latest development version of Apiato using --dev option.
  • You can initial a new git repository for your project using --git option.
caution

Make sure to place Composer's system-wide vendor bin directory in your $PATH so the apiato executable can be located by your system. This directory exists in different locations based on your operating system; however, some common locations include:

macOS: $HOME/.composer/vendor/bin Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin GNU / Linux Distributions: $HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin

For convenience, the Apiato installer can also create a Git repository for your new project. To indicate that you want a Git repository to be created, pass the --git flag when creating a new project:

apiato new my-api --git

This command will initialize a new Git repository for your project and automatically commit the base Apiato skeleton. The git flag assumes you have properly installed and configured Git (read requirements). You can also use the --branch flag to set the initial branch name:

apiato new my-api --git --branch="main"

Database Setup#

1) Migrate the Database:

Run the migration artisan command:

php artisan migrate

2) Seed the database with the artisan command:

php artisan db:seed

3) Optional. By default, Apiato seeds a "Super User", given the default admin role (the role has no Permissions set to it).

To give the admin role, access to all the seeded permissions in the system, run the following command, at any time.

php artisan apiato:permissions:toRole admin

OAuth 2.0 Setup#

1) Create encryption keys to generate secure access tokens and create "personal access" and "password grant" clients which will be used to generate access tokens:

php artisan passport:install

Documentation Setup#

1) Install ApiDocJs using NPM or your favorite dependencies manager:

npm install

2) Run php artisan apiato:apidoc

Visit API Docs Generator for more details.#

Testing Setup#

1) Open phpunit.xml and make sure the environments are correct for your domain.

2) run the tests

vendor/bin/phpunit

Development Environment Setup#

You can run Apiato on your favorite environment. Below you'll see how you can run it on top of Vagrant (using Laravel Homestead) or Docker (using Laradock).

We'll see how to use both tools, and you can pick one, or you can use other options like Laravel Valet, Laragon or even run it directly on your machine.

Heads up!
The ICANN has now officially approved .dev as a generic top level domain (gTLD). Therefore, it is not recommended to use .dev domains anymore in your local development setup! We use .test, however, you may change it to .example, or .localhost or whatever suits your needs. Read more.

Using Docker (with Laradock)#

Laradock is a Docker PHP development environment. It facilitates running PHP Apps on Docker.

Install Laradock.

Navigate into the laradock directory:

cd laradock

This directory contains a docker-compose.yml file. (From the LaraDock project).

If you haven't done so, rename env-example to .env.

cp env-example .env

Run the Docker containers:

docker-compose up -d nginx mysql redis beanstalkd

Make sure you are setting the Docker IP as Host for the DB and Redis in your .env file.

Add the domain to the Hosts file: /etc/hosts. We'll be using apiato.test as local domain (you can change it if you want).

Map the domain and its subdomains to 127.0.0.1:

127.0.0.1 apiato.test
127.0.0.1 api.apiato.test
127.0.0.1 admin.apiato.test

If you're using NGINX or Apache, make sure the server_name (in case of NGINX) or ServerName (in case of Apache) in your server config file, is set to the following apiato.test api.apiato.test admin.apiato.test. (Also don't forget to point the Root or DocumentRoot to the public directory inside apiato apiato/public).

Using Vagrant (with Laravel Homestead)#

Laravel Homestead is installed by default. If you have removed homestead you can install it using

composer require laravel/homestead --dev

Configure Homestead:#

Create the Homestead config file:

vendor/bin/homestead make

Map the api.apiato.test domain to the project public directory - Example:

sites:
- map: api.apiato.test
to: /{full-path-to}/apiato/public

You can also map other domains like apiato.test and admin.apiato.test to other web apps:

- map: apiato.test
to: /{full-path-to}/clients/web/user
- map: admin.apiato.test
to: /{full-path-to}/clients/web/admin

Note: in the example above the /{full-path-to}/clients/web/*** are separate apps, who live on their own repositories and in different folder then the Apiato one. If your Admins, Users or other type of Apps are within Apiato, then you must point them all to the Apiato project folder /{full-path-to}/apiato/public. So in that case you would have something like this:

- map: api.apiato.test
to: /{full-path-to}/apiato/public
- map: apiato.test
to: /{full-path-to}/apiato/public
- map: admin.apiato.test
to: /{full-path-to}/apiato/public

Configure Hosts:#

Open the hosts file on your local machine /etc/hosts.

We'll be using apiato.test as local domain (you can change it if you want).

Map the domain and its subdomains to the Vagrant IP Address:

192.168.10.10 apiato.test
192.168.10.10 api.apiato.test
192.168.10.10 admin.apiato.test

If you're using NGINX or Apache, make sure the server_name (in case of NGINX) or ServerName (in case of Apache) in your server config file, is set to the following apiato.test api.apiato.test admin.apiato.test. (Also don't forget to set your root or DocumentRoot to the public directory inside apiato apiato/public).

Run the Virtual Machine:

homestead up --provision

If you see No input file specified on the sub-domains! try running this command homestead halt && homestead up --provision.

Using anything else#

If you're not into virtualization solutions, you can set up your environment directly on your machine. Check the software's requirements list.

Let's Play#

Now let's see it in action

Open your web browser and visit:

  • http://apiato.test You should see an HTML page, with Apiato in the middle.
  • http://api.apiato.test You should see a response like this:
[
"Welcome to Apiato"
]

Open your HTTP client and call:

  • http://api.apiato.test/ You should see a JSON response with message: "Welcome to apiato.",
  • http://api.apiato.test/v1 You should see a JSON response with message: "Welcome to apiato (API V1).",

Make some HTTP calls to the API:

To make the calls you can use Postman, HTTPIE or any other tool you prefer.

Let's test the (user registration) endpoint http://api.apiato.test/v1/register with cURL:

curl -X POST -H "Accept: application/json" -H "Cache-Control: no-cache" -F "[email protected]" -F "password=so-secret" -F "name=John Doe" "http://api.apiato.test/v1/register"

You should get a response like this:

Header:

Access-Control-Allow-Origin โ†’ ...
Cache-Control โ†’ ...
Connection โ†’ keep-alive
Content-Language โ†’ en
Content-Type โ†’ application/json
Date โ†’ Wed, 11 Apr 2000 22:55:88 GMT
Server โ†’ nginx
Transfer-Encoding โ†’ chunked
Vary โ†’ Origin
X-Powered-By โ†’ PHP/7.7.7
X-RateLimit-Limit โ†’ 30
X-RateLimit-Remaining โ†’ 29

Body:

{
"data": {
"object": "User",
"id": "7VgmkMw7rR2pWO5j",
"name": "John Doe",
"email": "[email protected]",
"email_verified_at": null,
"gender": null,
"birth": null,
"created_at": "2021-04-12T13:33:24.000000Z",
"updated_at": "2021-04-12T13:33:24.000000Z",
"readable_created_at": "1 second ago",
"readable_updated_at": "1 second ago"
},
"meta": {
"include": [
"roles"
],
"custom": []
}
}
Last updated on by Moslem Deris