Skip to content

index.md

Latest commit

 

History

History
93 lines (83 loc) · 5.75 KB

index.md

File metadata and controls

93 lines (83 loc) · 5.75 KB

API Platform documentation

Tutorial

  1. Introduction
  2. Creating a Fully Featured API in 5 Minutes
  3. Consuming the API with AngularJS

API Platform Core: create a powerful APIs with ease

  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. Data Providers
  42. Custom Collection Data Provider
  43. Custom Item Data Provider
  44. Security
  45. Performance
  46. Enabling the Metadata Cache
  47. Using PPM (PHP-PM)
  48. Operation Path Naming
  49. Configuration
  50. Create a Custom Operation Path Naming 1. Defining the Operation Path Naming 2. Registering the Service 3. Configure it
  51. [Accept application/x-www-form-urlencoded Form Data] (core/form-data.md)
  52. FOSUserBundle Integration
  53. Creating a User Entity with Serialization Groups
  54. AngularJS Integration
  55. Restangular
  56. ng-admin

Schema Generator

  1. Introduction
  2. Getting Started
  3. Configuration

Deployment

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

Contributing

  1. Contribution guide
  2. Contributor Code Of Conduct