Built with API Platform and Symfony
The official API Platform documentation is available on the API Platform website.
This project is meant to get started with a simple API implementing powerfull features :
- JWT Authentication
- Validators on objects fields supplied by users
- The use of an ORM (doctrine) to deal with the database in a sweet way
- Indicate some fields as Readable and/or Writable by users
- A simple but securized membership management
The use of Symfony make this API maintainable, sustainable and easy to configure.
You can find the documentation there.
To get started, you first need to get authenticated.
Here is a demonstration account :
-
_username: demoUsername
-
_password: @demoPass
To authenticate yourself, send [_username, _password] as a POST request to this login page : http://82.165.202.90/login_check
You will receive a token used to access the api resources ( /users, /pages ... ).
API Platform is a next-generation PHP web framework designed to easily create API-first projects without compromising extensibility and flexibility:
- Expose in minutes an hypermedia REST API that works out of the box by reusing entity metadata (ORM mapping, validation and serialization) ; that embraces JSON-LD, Hydra and such other data formats like HAL, YAML, XML or CSV and provides a ton of features (CRUD, validation and error handling, relation embedding, filters, ordering...)
- Enjoy the beautiful automatically generated API documentation (Swagger)
- Use our awesome code generator to bootstrap a fully-functional data model from Schema.org vocabularies with ORM mapping and validation (you can also do it manually)
- Easily add JSON Web Token or OAuth authentication
- Create specs and tests with a developer friendly API context system on top of Behat
- Develop your website UI, webapp, mobile app or anything else you want using your preferred client-side technologies! Tested and approved with React, AngularJS (integration included), Ionic and native mobile apps
Created by Adam Rotard. Owner of TheWebdev
Support available upon request.