The API Platform Core Library
API Platform Core is an easy-to-use and powerful library to create hypermedia-driven REST APIs. It is a component of the API Platform framework. It can be used as a standalone or with the Symfony framework (recommended).
It embraces JSON for Linked Data (JSON-LD) and Hydra Core Vocabulary web standards but also supports HAL, Swagger/Open API, XML, JSON, CSV and YAML.
Build a working and fully featured CRUD API in minutes. Leverage the awesome features of the tool to develop complex and high-performance API-first projects.
If you are starting a new project, the easiest way to get API Platform up is to install the API Platform Distribution.
Features
Here is the fully featured REST API you'll get in minutes:
- Automatic CRUD自動CRUD
- Hypermedia (JSON-LD and HAL)ハイパーメディア (JSON-LD および HAL)
- Machine-readable documentation of the API in the Hydra and Swagger/Open API formats,
guessed from PHPDoc, Serializer, Validator and Doctrine ORM / MongoDB ODM metadataPHPDoc、Serializer、Validator、および Doctrine ORM / MongoDB ODM メタデータから推測される、Hydra および Swagger/Open API 形式の API の機械可読ドキュメント
- Nice human-readable documentation built with Swagger UI (including a sandbox) and/or ReDocSwagger UI (サンドボックスを含む) および/または ReDoc で構築された人間が読める優れたドキュメント
- Paginationページネーション
- A bunch of filtersフィルターの束
- Ordering注文
- Validation using the Symfony Validator Component (with groups support)Symfony Validator コンポーネントを使用した検証 (グループのサポートあり)
- Advanced authentication and authorization rules高度な認証および承認規則
- Errors serialization (Hydra and the RFC 7807 are supported)エラーのシリアル化 (Hydra および RFC 7807 がサポートされています)
- Advanced serialization thanks to the Symfony Serializer Component (groups support, relation embedding, max depth...)Symfony Serializer Component による高度なシリアライゼーション (グループのサポート、関係の埋め込み、最大深度...)
- Automatic routes registration自動ルート登録
- Automatic entrypoint generation giving access to all resourcesすべてのリソースへのアクセスを提供する自動エントリポイント生成
- User supportユーザーサポート
- JWT and OAuth supportJWT と OAuth のサポート
- Files and
\DateTime
and serialization and deserializationFiles と \DateTime とシリアル化と逆シリアル化
Everything is fully customizable through a powerful event system and strong OOP.
This bundle is extensively tested (unit and functional). The Fixtures/
directory contains a working app covering all features of the library.
Screencasts
The easiest and funniest way to learn how to use API Platform is to watch the more than 60 screencasts available on SymfonyCasts!