Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgrimaud/ratp-api-rest
This project turnkey is distributed as a middleware to expose RATP realtime data as REST resources
https://github.com/pgrimaud/ratp-api-rest
api hacktoberfest php ratp ratp-api realtime-schedules rest swagger-ui symfony4
Last synced: about 2 months ago
JSON representation
This project turnkey is distributed as a middleware to expose RATP realtime data as REST resources
- Host: GitHub
- URL: https://github.com/pgrimaud/ratp-api-rest
- Owner: pgrimaud
- License: mit
- Created: 2017-02-13T17:21:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T20:34:41.000Z (over 1 year ago)
- Last Synced: 2024-05-01T23:16:14.416Z (5 months ago)
- Topics: api, hacktoberfest, php, ratp, ratp-api, realtime-schedules, rest, swagger-ui, symfony4
- Language: PHP
- Homepage:
- Size: 791 KB
- Stars: 84
- Watchers: 13
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# REST RATP API (v4)
[](https://insight.sensiolabs.com/projects/0e42a9e2-ecb8-4412-8c88-b8f417f5ae2c)
This project turnkey is distributed as a middleware to expose RATP data as REST resources.
You can retrieve real time schedules for any given RER (train), Metro, Tramway, Bus or Noctilien stop in real time.
This project uses the package [horaires-ratp-sdk](https://github.com/pgrimaud/horaires-ratp-sdk) which consume the official RATP API.
Old version 3 README is available [here](https://github.com/pgrimaud/ratp-api-rest/blob/v3/README.md).
[Official documentation on GitHub](https://github.com/pgrimaud/horaires-ratp-api) with dashboard example.
## Demo
Demo is available here : [https://api-ratp.pierre-grimaud.fr/v4/](https://api-ratp.pierre-grimaud.fr/v4/)
## Requirements
- Access to the official RATP API (see [here](https://data.ratp.fr/explore/dataset/horaires-temps-reel/))
- PHP >= 8.0
- Redis server (for cache)
## Installation
First :
```
git clone [email protected]:pgrimaud/ratp-api-rest
cd ratp-api-rest
composer install
```
- Then configure your favorite webserver (Apache or Nginx) :
[more informations here](http://symfony.com/doc/current/setup/web_server_configuration.html).
- Manage your `.env` file : [more informations here](https://symfony.com/doc/current/configuration.html#the-env-file-environment-variables).
## TODO
- Add Opendata SNCF data
## Feedback or questions
You can [create an issue](https://github.com/pgrimaud/ratp-api-rest/issues) if needed or contact me on [Twitter](https://twitter.com/pgrimaud_).
## Contributing
Pull requests are appreciated. Everyone is welcome and even encouraged to contribute with their own improvements.
## Copyrights
This project is not affiliated with or endorsed by the [RATP](http://www.ratp.fr).
## License
Licensed under the terms of the MIT License.