Repolode
api-platform

api-platform/api-platform

自動ドキュメント、管理UI、Next.js・Nuxt・React Native向けクライアント生成機能を備えた、REST/GraphQL API構築用のPHPフレームワーク。

スター
9,201
フォーク
968
未解決の Issue
11
最終コミット
12 時間前

これは何?

API Platformは、APIファーストのプロジェクトを構築するためのWebフレームワークです。データモデルを通常のPHPクラスとして定義するか、既存のオントロジーをインポートすると、ページネーション、バリデーション、アクセス制御、フィルター、エラー処理を備えたハイパーメディアREST APIまたはGraphQL APIとして公開できます。

レスポンスはJSON-LD、Hydra、HAL、JSON:API、YAML、XML、CSVなど、複数の形式で提供できます。OpenAPIドキュメント、Reactで構築されたMaterial Designの管理インターフェース、そしてクライアントジェネレーターによるNext.js、Nuxt.js、React Native向けのクライアントの雛形を生成します。開発・デプロイ用のDockerおよびKubernetes構成も含まれています。

サーバーコンポーネントはSymfonyをベースにしており、デフォルトではDoctrine ORMを使用しますが、MongoDBやElasticsearchなど、ほかのデータプロバイダーも利用できます。クライアント側はReactに対応し、Vue.jsもサポートしています。このリポジトリには、新規プロジェクトの雛形を作成する`api-platform`インストーラーが含まれています。

主な機能

  • 01通常のPHPクラスまたはインポートしたオントロジーから、REST APIとGraphQL APIを構築できます。
  • 02JSON-LD、Hydra、HAL、JSON:API、YAML、XML、CSV形式での出力に対応しています。
  • 03OpenAPIドキュメントを自動生成します。
  • 04ReactベースのMaterial Design管理インターフェースを提供します。
  • 05Next.js、Nuxt.js、React Native向けのクライアントの雛形を作成します。
  • 06DockerおよびKubernetesのデプロイ用構成が含まれています。

ユースケース

  • Symfonyを使って、データ駆動型のRESTまたはGraphQLバックエンドを構築する。
  • UIコードを書かずに、APIに管理画面を追加する。
  • 型付きAPIを利用するNext.jsまたはReact Nativeアプリを開発し始める。
  • 標準的なハイパーメディア形式でデータを公開し、セマンティックWebと連携する。

クイックスタート

  1. 1

    Composerでapi-platformインストーラーをインストールします

    composer global require api-platform/installer
  2. 2

    インストーラーを実行して新しいプロジェクトのひな形を作成します

    api-platform my-app --framework=symfony --with-docker --with-pwa

使う前に知っておきたいこと

  • インストーラーを使用するには、あらかじめPHPとComposerをインストールしておく必要があります。

収録されている特集

トピック

よくある質問

api-platform とは?
自動ドキュメント、管理UI、Next.js・Nuxt・React Native向けクライアント生成機能を備えた、REST/GraphQL API構築用のPHPフレームワーク。 API Platformは、APIファーストのプロジェクトを構築するためのWebフレームワークです。データモデルを通常のPHPクラスとして定義するか、既存のオントロジーをインポートすると、ページネーション、バリデーション、アクセス制御、フィルター、エラー処理を備えたハイパーメディアREST APIまたはGraphQL APIとして公開できます。
api-platform は無料で使えますか?ライセンスは?
api-platform は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
api-platform は今もメンテナンスされていますか?
活発にメンテナンス中。api-platform の最終コミットは 2026年11月6日 です。
api-platform は何に使えますか?
Symfonyを使って、データ駆動型のRESTまたはGraphQLバックエンドを構築する。 UIコードを書かずに、APIに管理画面を追加する。 型付きAPIを利用するNext.jsまたはReact Nativeアプリを開発し始める。 標準的なハイパーメディア形式でデータを公開し、セマンティックWebと連携する。
api-platform のインストール方法は?
Composerでapi-platformインストーラーをインストールします: composer global require api-platform/installer インストーラーを実行して新しいプロジェクトのひな形を作成します: api-platform my-app --framework=symfony --with-docker --with-pwa
api-platform はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/api-platform/api-platform

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト