Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 3.84 KB

readme.md

File metadata and controls

86 lines (61 loc) · 3.84 KB

Using Lumen PHP Framework for REST API example.

Build Status Total Downloads Latest Stable Version Latest Unstable Version License

Laravel Lumen is a stunningly fast PHP micro-framework for building web applications with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Lumen attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as routing, database abstraction, queueing, and caching.

Official Documentation

Documentation for the framework can be found on the Lumen website.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at [email protected]. All security vulnerabilities will be promptly addressed.

License

The Lumen framework is open-sourced software licensed under the MIT license

THE CODING CHALLENGE CODE.

This part is about setting up a notification rest api. Notification Table has fields like

  • message_from,
  • message_to,
  • message,
  • message_type, -- 0 for warning, 1 for info and 2 for error.
  • message_status -- 0 for unread, 1 for read

Here are the rest api for:

  • save notification POST /v1/notification
  • $ curl -H 'Content-Type: application/json' --data '{"message_from":"from1", "message_to": "to1", "message":"tiny message", "message_type":"0", "message_status":"0"}' -X POST {baseurl}/v1/notification
  • retrieve unread notifications GET /v1/notifications/unread
  • $ curl -H 'Content-Type: application/json' -X GET {baseurl}/v1/notifications/unread
  • delete notification DELETE /vi/notification/{id}
  • $ curl -H 'Content-Type: application/json' -X DELETE {baseurl}/v1/notification/{id}

And its respective unit tests.

You can view php code:

  • routes /app/Http/routes
  • NotificationController /app/Http/Controllers
  • Notification /app/Models
  • generated eloquent mapping /database/migrations
  • seeding NotificationTableSeeder
  • NotificationTest /tests

Here's instruction to run and test the codechallege code.

  1. You must have PHP installed, with pdo_mysql or pdo_pgsql setup in php.ini

  2. Set the .env for the database, username and password, then apply this command to the console.

    • or you can comment in the boostrap/app.php the Dotenv::load(DIR.'/../'); to use database.php setup.

  3. php artisan migrate:refresh

  4. php artisan migrate

  5. php artisan db:seed

  6. phpunit

For heroku setup.

  1. heruko login
  2. heruko create
  3. heroku addons:create heroku-postgresql:hobby-dev // for free. Just change database.php just incase.
  4. git push heroku master
  5. heroku ps:scale web=1
  6. heroku run php artisan migrate
  7. heroku run php db:seed
  8. heroku open
  9. here's my heroku example: http://mijzcx-codechallenge-php.herokuapp.com/v1/notifications/unread

-- no cors, no session_token and authentication yet.

acknowlegement to Ali and Kiran of KyePot's coding challenge.