DOCSEARCHbyAlgolia
Submit Docs

API Platform Core

repository·main·Indexed 25 days ago

https://github.com/api-platform/core

A powerful engine for building hypermedia-driven REST and GraphQL APIs, designed to work with the Symfony framework. It natively supports standardized formats including JSON-LD, Hydra, OpenAPI, JSON:API, HAL, and Problem Details. The core library includes components for metadata generation, serialization, state providers and processors, validation, and HTTP caching, with integrations for Doctrine MongoDB ODM, Elasticsearch, and Laravel.

Tokens
12.2K
Snippets
27
Records
72
Agent score
82%

What's inside api-platform-core

  1. Overview of API Platform Validator

    main
    The Validator component is a part of the API Platform framework used to handle data validation. It integrates with the framework to ensure that incoming data (typically via API requests) conforms to defined constraints before being processed or persisted.

  2. Overview of API Platform OpenAPI component

    main
    The OpenAPI component of API Platform is responsible for building and serializing OpenAPI specifications (formerly known as Swagger). It allows developers to automatically generate and expose machine-readable documentation for their APIs based on the defined resources and configurations within the framework.

  3. Overview of API Platform JSON-LD component

    main
    The JSON-LD component of the API Platform framework is designed to organize and connect data using the JSON-LD standard. It helps transform disconnected data into a structured, linked format to create a more interconnected web of data. For detailed implementation guides, such as extending the JSON-LD context, refer to the official documentation.

  5. Overview of the API Platform Serializer

    main
    The Serializer component is responsible for converting PHP objects into various API formats (and vice versa). It is built on top of the Symfony Serializer component, providing the necessary infrastructure to handle data transformation for API responses and requests within the API Platform framework.

  6. Overview of API Platform MCP integration

    main

    The MCP (Model Context Protocol) component integrates the MCP PHP SDK with the API Platform framework. It works in conjunction with the MCP Bundle for Symfony to provide Model Context Protocol capabilities within your API Platform application.

    Warning: This component is currently experimental.

  7. Overview of API Platform GraphQL support

    main
    API Platform provides a dedicated GraphQL component that allows you to expose your data models as a GraphQL schema. It integrates with the core framework to provide queries, mutations, and subscriptions based on your existing API Platform resources.

  9. Overview of API Platform Core

    main
    API Platform Core is a system designed for creating hypermedia-driven REST and GraphQL APIs. It is a core component of the larger API Platform framework and is designed to be integrated with the Symfony framework via a dedicated bundle. It provides native support for several industry-standard open formats, enabling the creation of high-performance, API-first projects that are highly extensible.

  10. Use JSON:API with API Platform

    main
    API Platform provides a component for implementing the JSON:API specification. This allows you to build APIs that follow this popular JSON-based standard for structured data exchange, including features like resource relationships, compound documents, and standardized error formats.

  11. Use HAL (Hypertext Application Language) in API Platform

    main
    API Platform includes a component for implementing the HAL (Hypertext Application Language) specification. This allows your API to provide hypermedia links and structured representations of resources, enabling clients to discover relationships between resources through links. For detailed configuration and implementation details, refer to the official API Platform documentation on content negotiation.