{"id":21569234,"url":"https://github.com/symlex/rest-api","last_synced_at":"2026-05-18T22:06:08.856Z","repository":{"id":33958075,"uuid":"164094852","full_name":"symlex/rest-api","owner":"symlex","description":"Example REST API based on Symlex Core","archived":false,"fork":false,"pushed_at":"2023-02-01T20:45:47.000Z","size":429,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T12:28:41.259Z","etag":null,"topics":["example-project","php","rest","rest-api","symfony","symfony-application"],"latest_commit_sha":null,"homepage":"https://docs.symlex.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/symlex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"lastzero"}},"created_at":"2019-01-04T10:41:24.000Z","updated_at":"2020-01-09T18:04:23.000Z","dependencies_parsed_at":"2023-02-17T11:01:03.470Z","dependency_job_id":null,"html_url":"https://github.com/symlex/rest-api","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symlex%2Frest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symlex%2Frest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symlex%2Frest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/symlex%2Frest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/symlex","download_url":"https://codeload.github.com/symlex/rest-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166640,"owners_count":20409177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["example-project","php","rest","rest-api","symfony","symfony-application"],"created_at":"2024-11-24T11:07:34.826Z","updated_at":"2026-05-18T22:06:08.824Z","avatar_url":"https://github.com/symlex.png","language":"HTML","funding_links":["https://github.com/sponsors/lastzero"],"categories":[],"sub_categories":[],"readme":"# Example REST API based on [Symlex Core](https://github.com/symlex/symlex-core)\n\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n[![Documentation](https://readthedocs.org/projects/symlex-docs/badge/?version=latest\u0026style=flat)](https://docs.symlex.org/en/latest/)\n[![Community Chat](https://badges.gitter.im/symlex/community.png)](https://gitter.im/symlex/community)\n\nBefore you start, make sure you have PHP 7.2+, [Composer](https://getcomposer.org/) and [Docker](https://www.docker.com/) installed on your system \n([howto](https://docs.symlex.org/en/latest/osx/) for Mac OS X). \nInstead of using Docker, you can set up your own runtime environment based on the existing \n[Dockerfiles](https://github.com/symlex/rest-api/tree/master/app/docker).\nWe recommend using [Nginx](https://www.nginx.com/) with [PHP-FPM](http://php.net/manual/en/install.fpm.php)\nand URL [rewrite rules](https://github.com/symlex/symlex/blob/master/app/docker/nginx/site.conf) similar to Symfony.\n\nOur [main repository](https://github.com/symlex/symlex) shows how to use Symlex with RoadRunner for additional performance.\n\n**Step 1:** Run `composer` to create a new project:\n\n```\ncomposer create-project symlex/rest-api myapp\n```\n\nComposer will ask for config values to generate `app/config/parameters.yml` for you.\n\nMake sure `storage/cache` is writable so that cache files can be created by the app.\n\n**Step 2:** Start nginx and PHP using `docker-compose`:\n\n```\ncd myapp\ndocker-compose up\n```\n\n*Note: This docker-compose configuration is for testing and development purposes only. \nYou might need to tweak it if you run Docker with a different user for security reasons.\nOn OS X, the current release of Docker is [really slow](https://twitter.com/lastzero/status/829191426391027712) \nin executing PHP from the host's file system.*\n\n**Step 3:** Open http://localhost:8088/example/123 in a browser ([source](src/Controller/ExampleController.php)).\n\nTo open a terminal, run `docker-compose exec php sh`.\n\nYAML files located in `app/config` configure the app based on parameters and services.\nThe main config file is `app/config/rest.yml`.\n\nIf you add `localhost-debug` to your `/etc/hosts` and access the site with that, it will load in debug\nmode (you'll see a stack trace and other debug information on the error pages).\n\nOur complete framework documentation can be found on [docs.symlex.org](https://docs.symlex.org/en/latest/).\n\n## About ##\n\nSymlex is maintained by [Michael Mayer](https://blog.liquidbytes.net/about/) and\naims to simplify agile Web development by providing a working system that promotes best practices by example.\nMichael released his [first PHP framework](http://freshmeat.sourceforge.net/projects/awf) in 2001 and \nhas worked with various major framework vendors in the past.\nBuilding this would not have been possible without a lot of prior work by other developers.\nThank you to those and everyone who contributed!\n\n\u003e Choice is the enemy of productivity. Put another way, if your solution does everything, \n\u003e and has no opinions about anything, then it solves nothing. ― *Asim Aslam*\n\nFeel free to send an e-mail to [hello@symlex.org](mailto:hello@symlex.org) if you have any questions, \nneed [commercial support](https://blog.liquidbytes.net/contact/) or just want to say hello. \nWe welcome contributions of any kind. If you have a bug or an idea, read our \n[guide](https://docs.symlex.org/en/latest/contribute/) before opening an issue.\n\n\n## Donations ##\n\nSymlex is a non-profit project run entirely by volunteers. You're most welcome to support us via \n[GitHub Sponsors](https://github.com/sponsors/lastzero), especially if you need help with using our software.\nThey will match every donation in the first year.\n\nPlease leave a star if you like this project, it provides additional motivation to keep going. Thank you very much! \u003c3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymlex%2Frest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsymlex%2Frest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsymlex%2Frest-api/lists"}