s3bsch / laravel-api-only-demo Goto Github PK

Seed some demo users in order to be able to provide some API endpoints regarding users later on.

For the purpose of the demo, a user should be split into several models/tables:

• User…the very basic information regarding a user, needed for authentication
• UserProfile…profile data of a user, like first name, last name, birthday, etc.
• UserAddress…the address of the user

Enable tests to be automatically run via Github Actions on every push.

Initialize Laravel application in a state-of-the-art way.

• Laravel Sail or what?

I currently have no local PHP installed, just working with Docker containers in my work related projects. I like this approach very much and want to try to keep it this way.

Add some kind of info endpoint to the root of the API, instead of a 404 status code.

Remove all unnecessary stuff according to the tweet of Taylor Otwell and maybe more.

Provide Postman collection for API of this application.

Adapt exception handler to always return JSON.

Adapt readme file accordingly, add the purpose of this repository…

How about Laravel Sanctum?

Is it the default authentication mechanism in a Laravel v9 application?

Laravel Sanctum is shipped by default with Laravel v9. I think this was started with v8, but found no reference quickly.

What have to be changed to use Sanctum as intended for API only application?

By default Laravel Sanctum supports two different mechanisms to authenticate the current user/client. For SPAs a cookie based approach is suggested, which also prevents CSRF attacks. But there is also a second approach, which works with classic API bearer tokens. 1

For this demo application, I would like to adapt Laravel Sanctum in such a way, that it only works with API token based authentication. I'll try to disable and remove the whole cookie stuff.

Anything else to know about Sanctum?

Laravel Sanctum could/should be used in combination with Laravel Jetstream or Laravel Breeze.

Adapt the .env.example file to contain only the variables needed to run this application.

Setup a cache and database driver.

As database let's try to use SQLite as this should be good enough and I have never used it before.

• Run migrations
• Provide a simple status endpoint to check both

Add according open-source license.