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. NelmioApiDocBundle integration
8. Operations
9. Enabling and Disabling Operations
10. Configuring Operations
11. Creating Custom Operations and Controllers
12. Filters
13. Search Filter
14. Date Filter 1. Managing null Values
15. Boolean Filter
16. Numeric Filter
17. Order filter 1. Using a Custom Order Query Parameter Name
18. Filtering on Nested Properties
19. Enabling a Filter for All Properties of a Resource
20. Creating Custom Filters 1. Creating Custom Doctrine ORM Filters 2. Overriding Extraction of Properties from the Request
21. Serialization Groups and Relations
22. Configuration
23. Using Different Serialization Groups per Operation
24. Embedding Relations 1. Normalization 2. Denormalization 3. Changing the Serialization Context Dynamically
25. Name Conversion
26. Entity Identifier Case
27. Writable Entity Identifier
28. Embedding the Context
29. Validation
30. Using Validation Groups
31. Dynamic Validation Groups
32. Pagination
33. Disabling the Pagination
34. Changing the Number of Items per Page
35. The Event System
36. Content Negotiation
37. Enabling Several Formats
38. Registering a Custom Serializer
39. Creating a Responder
40. Using External JSON-LD Vocabularies
41. Extending JSON-LD context
42. Data Providers
43. Custom Collection Data Provider
44. Custom Item Data Provider
45. Security
46. Performance
47. Enabling the Metadata Cache
48. Using PPM (PHP-PM)
49. Doctrine Queries and Indexes 1. Search Filter 2. Unserialized Properties Hydratation
50. Operation Path Naming
51. Configuration
52. Create a Custom Operation Path Naming 1. Defining the Operation Path Naming 2. Registering the Service 3. Configure it
53. [Accept application/x-www-form-urlencoded Form Data] (core/form-data.md)
54. FOSUserBundle Integration
55. Creating a User Entity with Serialization Groups
56. AngularJS Integration
57. Restangular
58. 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. Contribution guide
3. Contributor Code Of Conduct