API Platform Documentation

The Distribution: Create Powerful APIs with Ease

  1. Getting Started with API Platform: Hypermedia and GraphQL API, Admin and Progressive Web App
    1. Installing the Framework
    2. It's Ready!
    3. Bringing your Own Model
    4. Validating Data
    5. Adding GraphQL Support
    6. The Admin
    7. A React/Redux Progressive Web App
    8. Other Features
  2. Testing and Specifying the API
    1. Running Unit Tests with PHPUnit
  3. Debugging
    1. Add a Development Stage to the Dockerfile
    2. Configure Xdebug with Docker Compose Override
    3. Troubleshooting

The API Component

  1. The API Platform Core Library
    1. Features
    2. Other resources
  2. Getting started
    1. Installing API Platform Core
    2. Before Reading this Documentation
    3. Mapping the Entities
  3. General Design Considerations
  4. Configuration
  5. Operations
    1. Enabling and Disabling Operations
    2. Configuring Operations
    3. Subresources
    4. Creating Custom Operations and Controllers
  6. Overriding Default Order
  7. Filters
    1. Doctrine ORM Filters
    2. Serializer Filters
    3. Creating Custom Filters
    4. ApiFilter Annotation
  8. The Serialization Process
    1. Overall Process
    2. Available Serializers
    3. The Serialization Context, Groups and Relations
    4. Using Serialization Groups
    5. Using Serialization Groups per Operation
    6. Changing the Serialization Context Dynamically
    7. Changing the Serialization Context on a Per-item Basis
    8. Name Conversion
    9. Decorating a Serializer and Adding Extra Data
    10. Entity Identifier Case
    11. Embedding the JSON-LD Context
  9. Validation
    1. Validating Submitted Data
    2. Using Validation Groups
    3. Using Validation Groups on Operations
    4. Dynamic Validation Groups
    5. Error Levels and Payload Serialization
  10. Errors Handling
    1. Converting PHP Exceptions to HTTP Errors
  11. Pagination
    1. Disabling the Pagination
    2. Changing the Number of Items per Page
    3. Changing Maximum items per page
    4. Partial Pagination
    5. Avoiding double SQL requests on Doctrine
  12. The Event System
  13. Content Negotiation
    1. Enabling Several Formats
    2. Enabling Additional Formats On a Specific Resource/Operation
    3. Registering a Custom Serializer
    4. Writing a Custom Normalizer
  14. Using External Vocabularies
  15. Extending JSON-LD context
  16. Data Providers
    1. Custom Collection Data Provider
    2. Custom Item Data Provider
    3. Injecting the Serializer in an ItemDataProvider
    4. Injecting Extensions (Pagination, Filter, EagerLoading etc.)
  17. Data Persisters
    1. Creating a Custom Data Persister
  18. Identifiers
    1. Custom identifier normalizer
    2. Supported identifiers
  19. Extensions
    1. Custom Extension
    2. Example
  20. Security
    1. Configuring the Access Control Message
  21. Performance
    1. Enabling the Built-in HTTP Cache Invalidation System
    2. Enabling the Metadata Cache
    3. Using PPM (PHP-PM)
    4. Doctrine Queries and Indexes
  22. Operation Path Naming
    1. Configuration
    2. Create a Custom Operation Path Resolver
  23. Accept application/x-www-form-urlencoded Form Data
    1. Create your DeserializeListener Decorator
    2. Creating the Service Definition
  24. FOSUserBundle Integration
    1. Installing the Bundle
    2. Enabling the Bridge
    3. Creating a User Entity with Serialization Groups
  25. JWT Authentication
    1. Installing LexikJWTAuthenticationBundle
    2. Documenting the Authentication Mechanism with Swagger/Open API
    3. Testing with Behat
  26. NelmioApiDocBundle Integration
  27. AngularJS Integration
    1. Restangular
    2. ng-admin
  28. Swagger / Open API Support
    1. Overriding the Swagger Documentation
    2. Using the Swagger Context
    3. Changing the Name of a Definition
    4. Changing Operations in the Swagger Documentation
    5. Changing the Swagger UI Location
    6. Using the Swagger Command
    7. Overriding the UI Template
  29. GraphQL Support
    1. Overall View
    2. Enabling GraphQL
    3. GraphiQL
    4. Filters
    5. Security (access_control)
    6. Serialization Groups
  30. Handling Data Transfer Objects (DTOs)
    1. How to Use a DTO for Writing
    2. How to Use a DTO for Reading
  31. Handling File Upload
    1. Installing VichUploaderBundle
    2. Configuring the Entity Receiving the Uploaded File
    3. Handling File Upload
    4. Making a Request to the /media_objects Endpoint
    5. Linking a MediaObject Resource to Another Resource

The Schema Generator Component

  1. The schema generator
    1. What is Schema.org?
    2. Why use Schema.org data to generate a PHP model?
    3. Documentation
  2. Getting Started
    1. Installation
    2. Model Scaffolding
    3. Cardinality Extraction
  3. Configuration
    1. Customizing PHP Namespaces
    2. Forcing a Field Range
    3. Forcing a Field Cardinality
    4. Forcing a Relation Table Name
    5. Forcing (or Disabling) a Class Parent
    6. Forcing a Class to be Abstract
    7. Forcing a Nullable Property
    8. Forcing a Unique Property
    9. Making a Property Read Only
    10. Making a Property Write Only
    11. Forcing a Property to be in a Serialization Group
    12. Forcing an Embeddable Class to be Embedded
    13. Author PHPDoc
    14. Disabling Generators and Creating Custom Ones
    15. Skipping Accessor Method Generation
    16. Disabling the id Generator
    17. Generating UUIDs
    18. User submitted UUIDs
    19. Generating Custom IDs
    20. Disabling Usage of Doctrine Collection
    21. Changing the Field Visibility
    22. Generating @Assert\Type Annotations
    23. Forcing Doctrine Inheritance Mapping Annotation
    24. Interfaces and Doctrine Resolve Target Entity Listener
    25. Custom Schemas
    26. Checking GoodRelation Compatibility
    27. PHP File Header
    28. Full Configuration Reference

The Admin Component

  1. The API Platform Admin
    1. Features
  2. Getting Started
    1. Installation
    2. Creating the Admin
    3. Customizing the Admin
  3. Authentication Support
  4. Handling Relations to Collections
    1. Customizing a Property
    2. Using an Autocomplete Input for Relations

The Client Generator Component

  1. The API Platform Client Generator
    1. Features
  2. React generator
  3. Vue.js generator
  4. Troubleshooting

Deployment

  1. Deploying API Platform Applications
  2. Deploying to a Kubernetes Cluster
    1. Preparing Your Cluster and Your Local Machine
    2. Creating and Publishing the Docker Images
    3. Deploying
    4. Initializing the Database
    5. Tiller RBAC Issue
  3. Deploying an API Platform App on Heroku

Extra

  1. The Release Process
  2. API Platform's Philosophy
  3. Troubleshooting
    1. Using Docker
    2. Using API Platform and JMS Serializer in the same project
  4. Contribution guides
  5. Contributor Code of Conduct