Building an Operation-Oriented Api using PHP and the Symfony Framework: A step-by-step guide
Building an Operation-Oriented Api using PHP and the Symfony Framework: A step-by-step guide by IGNACIO COLOMINA TORREGROSA
English | June 16, 2024 | ISBN: N/A | ASIN: B0D79KGL7P | 172 pages | EPUB | 0.25 Mb
English | June 16, 2024 | ISBN: N/A | ASIN: B0D79KGL7P | 172 pages | EPUB | 0.25 Mb
In this book, the author tries to show how to use the Symfony framework powerful features to build an API using the operation concept as a resource. Starting from this base, the author takes advantage of several tools and components of the Symfony framework to build an API capable of finding out what operation must be executed and what data is required to execute it based on the information received within the request payload.
To progress step by step, the book has been divided into the following parts or chapters:
- Introduction: This part explains how an operation-oriented API can help to define API operations that could not be defined using a CRUD way.
- Crafting inputs, outputs and operations: This part uses many Symfony DIC features such as Tagged iterators and service configurators and some components like Validation, Serializer and the Symfony Event System to construct the necessary services to discover and execute operations.
- Securing operations: This part uses Symfony firewalls and voters to protect both the API endpoint and the operations. As a plus, it shows how to configure a rate limiter to control the number of requests received.
- Background Execution of API Operations: This part uses the Symfony Messenger so that operations that can take some time to be executed can be performed in the background.
- Context-Specific Operations: This part shows how CRUD and Operation-Oriented endpoints can live together and how to control what operations an endpoint can execute depending on its context.
- Testing the API: As a last part, we will use the Symfony API Testing capabilities to create some tests that ensures our API behaves as expected.
- This book assumes a certain level of familiarity with the Symfony framework. It is not a tutorial or guide about the framework but a guide about how to construct an operation-oriented api using the Symfony features.
- This book does not delve into the development of specific operations themselves. While we may use operation examples like "SendPayment" for illustrative purposes, the primary goal is to demonstrate how to construct the necessary code to establish a unified API endpoint capable of handling various operations effectively.