/eccube-api

Primary LanguageJavaScriptGNU Lesser General Public License v2.1LGPL-2.1

EC-CUBE Web API

インストール方法

あらかじめ, EC-CUBE3のインストールを行った状態で, 以下を実行してください

// ec-cube のプラグインディレクトリに移動
cd [ec-cube root]/app/Plugin

// ec-cube apiのレポジトリをclone
git clone https://github.com/EC-CUBE/eccube-api.git EccubeApi

// composerの実行
curl -sS https://getcomposer.org/installer | php
php ./composer.phar install --dev --no-interaction -o

// ec-cube apiのプラグインをインストール, 有効化
cd [ec-cube root]
app/console plugin:develop install --code=EccubeApi
app/console plugin:develop enable --code=EccubeApi

動作確認方法

アプリケーションの作成

設定>メンバー管理>メンバー編集>APIクライアント一覧からアプリケーションを作成します

作成後、APIドキュメントを開くを押下

swagger ui の画面へ遷移すれば成功です

APIクライアントコードの生成

swagger editorを利用して、APIクライアントコードを自動生成することが出来ます

  • eccubeapi.ymlに記述されている内容をswagger editorに貼り付けます
  • localhost, basePathを環境に応じて修正します
  • Generate Clientメニューから、任意の言語でAPIクライアントのソースコードを生成することが出来ます

開発ドキュメント

https://ec-cube.github.io/api