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).

API Platform Core は、ハイパーメディア駆動の REST API を作成するための使いやすく強力なライブラリです。API Platform フレームワークのコンポーネントです。スタンドアロンとして、または Symfonyframework (推奨) と一緒に使用できます。

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.

JSON for Linked Data (JSON-LD) と Hydra Core Vocabulary Web 標準を採用していますが、HAL、Swagger/Open API、XML、JSON、CSV、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.

動作するフル機能の CRUD API を数分で構築します。ツールの優れた機能を活用して、複雑で高性能な API ファースト プロジェクトを開発します。

If you are starting a new project, the easiest way to get API Platform up is to install the API Platform Distribution.

新しいプロジェクトを開始する場合、API プラットフォームを起動する最も簡単な方法は、API プラットフォーム ディストリビューションをインストールすることです。

Screenshot

Features

Here is the fully featured REST API you'll get in minutes:

以下は、数分で取得できるフル機能の REST API です。

  • 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 metadata
    PHPDoc、Serializer、Validator、および Doctrine ORM / MongoDB ODM メタデータから推測される、Hydra および Swagger/Open API 形式の API の機械可読ドキュメント
  • Nice human-readable documentation built with Swagger UI (including a sandbox) and/or ReDoc
    Swagger 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 support
    JWT と OAuth のサポート
  • Files and \DateTime and serialization and deserialization
    Files と \DateTime とシリアル化と逆シリアル化

Everything is fully customizable through a powerful event system and strong OOP.

強力なイベント システムと強力な OOP により、すべてが完全にカスタマイズ可能です。

This bundle is extensively tested (unit and functional). The Fixtures/ directory contains a working app covering all features of the library.

このバンドルは広範囲にテストされています (ユニットと機能)。 Fixtures/ ディレクトリには、ライブラリのすべての機能をカバーする実用的なアプリが含まれています。

Screencasts

SymfonyCasts, API Platform screencasts

The easiest and funniest way to learn how to use API Platform is to watch the more than 60 screencasts available on SymfonyCasts!

API プラットフォームの使い方を学ぶ最も簡単で楽しい方法は、SymfonyCast で利用できる 60 以上のスクリーンキャストを見ることです!