index.md

API Platform documentation

API Platform Distribution: create a powerful APIs with ease

1. Creating a Fully Featured API in 5 Minutes
2. Testing and Specifying the API

API Platform Core library

1. Introduction
2. Getting Started
3. Installing API Platform Core
4. Before Reading this Documentation
5. Mapping the Entities
6. Configuration
7. Operations
8. Enabling and Disabling Operations
9. Configuring Operations
10. Creating Custom Operations and Controllers
11. Filters
12. Search Filter
13. Date Filter 1. Managing null Values
14. Boolean Filter
15. Numeric Filter
16. Order filter 1. Using a Custom Order Query Parameter Name
17. Filtering on Nested Properties
18. Enabling a Filter for All Properties of a Resource
19. Creating Custom Filters 1. Creating Custom Doctrine ORM Filters 2. Overriding Extraction of Properties from the Request
20. Serialization Groups and Relations
21. Configuration
22. Using Different Serialization Groups per Operation
23. Embedding Relations 1. Normalization 2. Denormalization 3. Changing the Serialization Context Dynamically
24. Name Conversion
25. Entity Identifier Case
26. Writable Entity Identifier
27. Embedding the Context
28. Validation
29. Using Validation Groups
30. Dynamic Validation Groups
31. Pagination
32. Disabling the Pagination
33. Changing the Number of Items per Page
34. The Event System
35. Content Negotiation
36. Enabling Several Formats
37. Registering a Custom Serializer
38. Creating a Responder
39. Using External JSON-LD Vocabularies
40. Extending JSON-LD context
41. Data Providers
42. Custom Collection Data Provider
43. Custom Item Data Provider
44. Extensions
45. Custom Extension
46. Filter upon the current user
47. Security
48. Performance
49. Enabling the Metadata Cache
50. Using PPM (PHP-PM)
51. Doctrine Queries and Indexes 1. Search Filter 2. Eager Loading
    1. Max Joins
    2. Force Eager
    3. Override at Resource and Operation Level
    4. Disable Eager Loading
52. Operation Path Naming
53. Configuration
54. Create a Custom Operation Path Naming 1. Defining the Operation Path Naming 2. Registering the Service 3. Configure it
55. [Accept application/x-www-form-urlencoded Form Data] (core/form-data.md)
56. FOSUserBundle Integration
57. Creating a User Entity with Serialization Groups
58. Adding a JWT authentication using LexikJWTAuthenticationBundle
59. NelmioApiDocBundle integration
60. AngularJS Integration
61. Restangular
62. ng-admin

Schema Generator: Generate Data Models from Open Vocabularies

1. Introduction
2. Getting Started
3. Configuration

Deployment

1. Introduction
2. Deploying an API Platform App on Heroku
3. Using API Platform with Docker

Extra

1. The project's philosophy
2. Troubleshooting
3. Contribution guide
4. Contributor Code Of Conduct