https://github.com/api-platform/laravel-demo
Demo app for the API Platform framework using Laravel
https://github.com/api-platform/laravel-demo
api api-platform laravel php
Last synced: about 1 month ago
JSON representation
Demo app for the API Platform framework using Laravel
- Host: GitHub
- URL: https://github.com/api-platform/laravel-demo
- Owner: api-platform
- License: mit
- Created: 2025-01-08T10:50:45.000Z (4 months ago)
- Default Branch: 4.0
- Last Pushed: 2025-02-10T06:56:33.000Z (2 months ago)
- Last Synced: 2025-03-10T07:37:11.433Z (about 2 months ago)
- Topics: api, api-platform, laravel, php
- Language: PHP
- Homepage:
- Size: 288 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
API Platform - Laravel Demo
This application is a demonstration for the [API Platform Framework](https://api-platform.com/) using Laravel.
> [!NOTE]
> If you use API Platform with Symfony, check out the [API Platform Symfony Demo](https://github.com/api-platform/demo).
[//]: # (TODO: Try it online at .)
[//]: # (TODO: add CI badges)
## Install
```console
git clone https://github.com/api-platform/laravel-demo.git
cd laravel-demo
composer install
php artisan api-platform:install
php artisan migrate
composer dev
```
> [!TIP]
> [Read the official "Getting Started" Guide for Laravel](https://api-platform.com/docs/laravel/).
Your API is up and running! 🎉
- Visit [http://127.0.0.1:8000/api/](http://127.0.0.1:8000/api/) to explore the fully active and documented API.
- Check out the demo application at [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
[//]: # (TODO: ## What Can I Find In This Demo?)
[//]: # ()
[//]: # (This demo application contains several things you may be interested:)
[//]: # ()
[//]: # (| Feature | Usage |)
[//]: # (|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|)
[//]: # (| [Bringing your Own Model](https://api-platform.com/docs/distribution/#bringing-your-own-model) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BApiResource%22&type=code) |)
[//]: # (| [Model Scaffolding](https://api-platform.com/docs/schema-generator/getting-started/#model-scaffolding) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BApiProperty%28types%3A%22&type=code) |)
[//]: # (| [Plugging the Persistence System](https://api-platform.com/docs/distribution/#plugging-the-persistence-system) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BORM%22&type=code) |)
[//]: # (| [Exposing Enums with API Platform](https://les-tilleuls.coop/blog/exposez-vos-enums-avec-api-platform) | [Search usage](api/src/Enum) |)
[//]: # (| [Validating Data](https://api-platform.com/docs/distribution/#validating-data) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BAssert%22&type=code) |)
[//]: # (| [Configuring Operations](https://api-platform.com/docs/core/operations/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22operations%3A%22&type=code) |)
[//]: # (| [Defining Which Operation to Use to Generate the IRI](https://api-platform.com/docs/core/operations/#defining-which-operation-to-use-to-generate-the-iri) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22itemUriTemplate%3A%22&type=code) |)
[//]: # (| [Subresources](https://api-platform.com/docs/core/subresources/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc%2FEntity+%22uriTemplate%3A+%27%2Fbooks%2F%7BbookId%7D%2Freviews%7B._format%7D%27%22&type=code) |)
[//]: # (| [Doctrine ORM Filters](https://api-platform.com/docs/core/filters/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BApiFilter%22&type=code) |)
[//]: # (| [Creating Custom Doctrine ORM Filters](https://api-platform.com/docs/core/filters/#creating-custom-doctrine-orm-filters) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi+%22NameFilter%22+OR+%22app.filter.user.admin.name%22&type=code) |)
[//]: # (| [Overriding Default Order](https://api-platform.com/docs/core/default-order/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22order%3A%22&type=code) |)
[//]: # (| [Changing the Number of Items per Page Client-side For a Specific Resource](https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page-client-side-for-a-specific-resource) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22paginationClientItemsPerPage%22&type=code) |)
[//]: # (| [Advanced serialization](https://api-platform.com/docs/core/serialization/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc+%22%23%5BGroups%22&type=code) |)
[//]: # (| [User Support](https://api-platform.com/docs/core/user/) | [Search usage](api/src/Entity/User.php) |)
[//]: # (| [Custom Doctrine ORM Extension](https://api-platform.com/docs/core/extensions/) | [Search usage](api/src/Doctrine/Orm/Extension) |)
[//]: # (| [Custom State Processor](https://api-platform.com/docs/core/state-processors/) | [Search usage](api/src/State/Processor) |)
[//]: # (| [Creating Async APIs using the Mercure Protocol](https://api-platform.com/docs/core/mercure/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc%2FEntity+%22mercure%3A%22&type=code) |)
[//]: # (| [Advanced Authentication and Authorization Rules](https://api-platform.com/docs/core/security/) | [Search usage](https://github.com/search?q=repo%3Aapi-platform%2Fdemo+path%3Aapi%2Fsrc%2FEntity+%22security%3A%22+OR+%22securityPostDenormalize%3A%22&type=code) |)
[//]: # (| [API Testing](https://api-platform.com/docs/core/testing/) | [Search usage](api/tests) |)
[//]: # (| [The Admin](https://api-platform.com/docs/distribution/#the-admin) | [Search usage](pwa/pages/admin) |)
[//]: # (| [A Next.js Web App](https://api-platform.com/docs/distribution/#a-nextjs-web-app) | [Search usage](pwa) |)
[//]: # (| [Deploying to a Kubernetes Cluster](https://api-platform.com/docs/deployment/kubernetes) | [Search usage](helm/api-platform) |)
## Contributing
[Read the contributing guide](.github/CONTRIBUTING.md)
## Credits
Created by [Vincent Amstoutz](https://github.com/vinceAmstoutz). Commercial support available
at [Les-Tilleuls.coop](https://les-tilleuls.coop/).