Git Product home page Git Product logo

eccube-api's Introduction

EC-CUBE Web API

Build Status Coverage Status

インストール方法

あらかじめ, 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

.htaccess の設定

一部のレンタルサーバーや SAPI CGI/FastCGI の環境では、認証情報(Authorization ヘッダ)が取得できず、 401 Unauthorized エラーとなってしまう場合があります。 この場合は、 <ec-cube-install-path>/html/.htaccess に以下を追記してください。

RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]

動作確認方法

アプリケーションの作成

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

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

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

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

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

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

開発ドキュメント

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

eccube-api's People

Contributors

k-yamamura avatar nanasess avatar ryo-endo avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.