Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/habibun/symfony-api-platform
Symfony with API Platform
https://github.com/habibun/symfony-api-platform
api api-plateform api-platform doctrine hydra json json-ld openapi php php8 postgresql rest-api restful-api swagger symfony symfony5 twig vue vuejs
Last synced: 2 days ago
JSON representation
Symfony with API Platform
- Host: GitHub
- URL: https://github.com/habibun/symfony-api-platform
- Owner: habibun
- License: mit
- Created: 2023-02-24T08:40:19.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-08T11:17:25.000Z (almost 2 years ago)
- Last Synced: 2024-11-14T18:42:00.886Z (2 months ago)
- Topics: api, api-plateform, api-platform, doctrine, hydra, json, json-ld, openapi, php, php8, postgresql, rest-api, restful-api, swagger, symfony, symfony5, twig, vue, vuejs
- Homepage:
- Size: 438 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About The Project
[Symfony][symfony_website] with [API Platform][api_platform_website]
Please check the [projects](#projects) section for more details.
## Overview
| Branch | API Platform Version | Symfony Version | PHP Version |
|------------------------------|----------------------|-----------------|-------------|
| [v2-extending][v2-extending] | `^2.7` | `^5.4` | `^8.0` |
| [v2-security][v2-security] | `^2.7` | `^5.4` | `^8.0` |
| [v2][v2] | `^2.7` | `^5.4` | `^8.0` |
## Projects
Sample application using API Platform V2 Custom Resources
**Code:** https://github.com/habibun/symfony-api-platform/tree/v2-extending
**Resources:**
- [API Platform Part 3: Custom Resources](https://symfonycasts.com/screencast/api-platform-extending)
### Prerequisites
- [Symfony CLI][symfony_cli], [PHP][php], [Composer][composer], [Git][git], [Node.js][node]
### Installation
```bash
# Clone the repository using the command
git clone [email protected]:habibun/symfony-api-platform.git
# Navigate into the cloned directory
cd symfony-api-platform
# Checkout to project branch
git checkout v2-extending
# Create .env.local file
make init
```
In the .env.local file, configure the environment variables for docker compose
```bash
# Start docker compose services
make up
```
Configure the database connection in the .env.local file
```bash
# Install project
make install
# Start the local development server
make start
```
Please check more rules in [Makefile][v2_extending_makefile].
##
Sample application using API Platform V2 Security
**Code:** https://github.com/habibun/symfony-api-platform/tree/v2-security
**Resources:**
- [API Platform Part 2: Security](https://symfonycasts.com/screencast/api-platform2-security)
#### Installation
```bash
git clone [email protected]:habibun/symfony-api-platform.git
cd symfony-api-platform
git checkout v2-security
symfony composer install
```
Sample application using API Platform V2
**Code:** https://github.com/habibun/symfony-api-platform/tree/v2-security
**Resources:**
- [API Platform Part 2: Security](https://symfonycasts.com/screencast/api-platform2-security)
#### Installation
```bash
git clone [email protected]:habibun/symfony-api-platform.git
cd symfony-api-platform
git checkout v2
symfony composer install
```
## Learn More
- [API Platform Docs][api_platform_docs]
- [Swagger Docs][swagger_docs]
- [Swagger UI](https://swagger.io/tools/swagger-ui/)
- [RDF](https://www.w3.org/RDF/)
- [JSON-LD](https://en.wikipedia.org/wiki/JSON-LD)
- [OpenAPI Specification](https://oai.github.io/Documentation/)
- [Hydra](https://www.hydra-cg.com/)
- [A simple PHP API extension for DateTime](https://github.com/briannesbitt/carbon)
- [The Serializer Component](https://symfony.com/doc/5.4/components/serializer.html)
## Related
- [Symfony](https://github.com/habibun/symfony)
## License
Distributed under the MIT License. See **[LICENSE][license]** for more information.
[//]: # (Links)
[license]: https://github.com/habibun/symfony-api-platform/blob/main/LICENSE
[symfony_website]: https://symfony.com/
[api_platform_website]: https://api-platform.com/
[api_platform_docs]: https://api-platform.com/docs
[swagger_docs]: https://swagger.io/docs/
[v2]: https://github.com/habibun/symfony-api-platform/tree/v2
[v2_tt]: https://github.com/habibun/symfony-api-platform/tree/v2 "Sample application using API Platform V2"
[v2-security]: https://github.com/habibun/symfony-api-platform/tree/v2-security
[v2-security_tt]: https://github.com/habibun/symfony-api-platform/tree/v2-security "Sample application using API Platform V2 Securiity"
[v2-extending]: https://github.com/habibun/symfony-api-platform/tree/v2-extending
[v2-extending_tt]: https://github.com/habibun/symfony-api-platform/tree/v2-extending "Sample application using API Platform V2 Custom Resources"
[v2_extending_makefile]: https://github.com/habibun/symfony-api-platform/blob/v2-extending/Makefile
[symfony_cli]: https://symfony.com/download
[php]: https://www.php.net/
[composer]: https://getcomposer.org/
[git]: https://git-scm.com/
[node]: https://nodejs.org/