I make apiary about endpoint REST API. There are six endpoint with method GET, POST, PUT, PATCH, and DELETE in each endpoint. But I didn't make Patch method, I just use Put. Below its endpoints list with methods.

1. /posts

   • GET /posts
   • GET /posts/{id}
   • GET /posts/{id}/comments
   • GET /posts?userId={id}
   • POST /posts
   • PUT /posts/{id}
   • DELETE /posts/{id}

2. /comments

   • GET /comments
   • GET /comments/{id}
   • GET /comments?postId={id}
   • POST /comments
   • PUT /comments/{id}
   • DELETE /comments/{id}

3. /albums

   • GET /albums
   • GET /albums/{id}
   • GET /albums/{id}/photos
   • GET /albums?userId={id}
   • POST /albums
   • PUT /albums/{id}
   • DELETE /albums/{id}

4. /photos

   • GET /photos
   • GET /photos/{id}
   • GET /photos?albumId={id}
   • POST /photos
   • PUT /photos/{id}
   • DELETE /photos/{id}

5. /todos

   • GET /todos
   • GET /todos/{id}
   • GET /todos?userId={id}
   • POST /todos
   • PUT /todos/{id}
   • DELETE /todos/{id}

6. /users

   • GET /users
   • GET /users/{id}
   • GET /users/{id}/posts
   • GET /users/{id}/albums
   • GET /users/{id}/todos
   • POST /users
   • PUT /users/{id}
   • DELETE /users/{id}

I also make authentication with Oauth 2. The endpoint is - POST /oauth/token - GET /test

After that, I implemented the apiary in this project with framework laravel and database mysql.

You can clone this repo with git clone [email protected]:prilandini/Apiary.git or download, and then install composer install in the folder. After that there are some commands before use this project, like setup the databases, generate key in file .env, migrate the tables and also seeders, and the last is make oauth for authentications. This project use Oauth2. Here is a more detailed explanation.

You can setup your database in file .env with the name database, username, and password your databases.

After you install laravel application, you need application key. To get it you can run php artisan key:generate and input the key in APP_KEY there are in file .env. If you run the server, you should to refresh it after input or change application key.

You can do migration by php artisan migrate to input tables in you database.

I make example of the data in each tables, you can run php artisan db:seed to do seeder.

But to access the data, we need authentication. I've done some preparation to build Oauth, you just to run php artisan passport:install to get client id and client secret. After that you can request an access token by issuing a POST request to the /oauth/token route with email as username and password user. Use client id 2, because client id 1 is for a personal access client. Do as below.

{
	"grant_type": "password",
	"client_id": "2",
    "client_secret": "wnA9M6SCgDHm2ongk46MX1F7ChUSgxqfpCrIbnTA",
    "username": "[email protected]",
    "password": "pril44",
    "scope": ""
}

Or if you need some referensi, you can to go in laravel documentation.

If you have done get token, you can use it in headers with the key authentication and the value Bearer <your token>.

Run php artisan serve to run the server.

I make endpoint to test it /test. If it success to authorization you will get a request Hello. After that, you can use the token to access all endpoint.