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
    1. Installing API Platform Core
    2. Before Reading this Documentation
    3. Mapping the Entities
  3. Configuration
  4. Operations
    1. Enabling and Disabling Operations
    2. Configuring Operations
    3. Creating Custom Operations and Controllers
  5. Filters
    1. Search Filter
    2. Date Filter
    3. Managing null Values
    4. Boolean Filter
    5. Numeric Filter
    6. Order filter
    7. Using a Custom Order Query Parameter Name
    8. Filtering on Nested Properties
    9. Enabling a Filter for All Properties of a Resource
    10. Creating Custom Filters
    11. Creating Custom Doctrine ORM Filters
    12. Overriding Extraction of Properties from the Request
  6. Serialization Groups and Relations
    1. Configuration
    2. Using Different Serialization Groups per Operation
    3. Embedding Relations
    4. Normalization
    5. Denormalization
    6. Changing the Serialization Context Dynamically
    7. Name Conversion
    8. Entity Identifier Case
    9. Writable Entity Identifier
    10. Embedding the Context
  7. Validation
    1. Using Validation Groups
    2. Dynamic Validation Groups
  8. Pagination
    1. Disabling the Pagination
    2. Changing the Number of Items per Page
  9. The Event System
  10. Content Negotiation
    1. Enabling Several Formats
    2. Registering a Custom Serializer
    3. Creating a Responder
  11. Using External JSON-LD Vocabularies
  12. Extending JSON-LD context
  13. Data Providers
    1. Custom Collection Data Provider
    2. Custom Item Data Provider
  14. Extensions
    1. Custom Extension
    2. Filter upon the current user
  15. Security
  16. Performance
    1. Enabling the Metadata Cache
    2. Using PPM (PHP-PM)
    3. Doctrine Queries and Indexes
    4. Search Filter
    5. Eager Loading
      1. Max Joins
      2. Force Eager
      3. Override at Resource and Operation Level
      4. Disable Eager Loading
  17. Operation Path Naming
    1. Configuration
    2. Create a Custom Operation Path Naming
    3. Defining the Operation Path Naming
    4. Registering the Service
    5. Configure it
  18. Accept application/x-www-form-urlencoded Form Data
  19. FOSUserBundle Integration
    1. Creating a User Entity with Serialization Groups
  20. Adding a JWT authentication using LexikJWTAuthenticationBundle
  21. NelmioApiDocBundle integration
  22. AngularJS Integration
    1. Restangular
    2. 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

 Edit on GitHub