php swagger - 如何在magento中實現自定義REST API?




(3)

我正在嘗試創建自定義REST API。 我創建了自己的模塊Custom / Restapi.Custom [Namespace],Restapi [Module name]。

在etc文件夾中,我創建了config.xml和api2.xml。 以下是代碼 - :

config.xml中

<?xml version="1.0"?>
<config>
    <modules>
        <Custom_Restapi>
            <version>0.1.0.0</version>
        </Custom_Restapi>
    </modules>
    <global>
        <models>
            <restapi>
                <class>Custom_Restapi_Model</class>
            </restapi>
        </models>
</config>

api2.xml

<config>
    <api2>
        <resource_groups>
            <restapi translate="title" module="Custom_Restapi">
                <title>Custom Rest API</title>
                <sort_order>10</sort_order>
            </restapi>
        </resource_groups>
        <resources>
            <restapi translate="title" module="Custom_Restapi">
                <group>restapi</group>
                <model>restapi/api2_restapi</model>
                <title>Testing My Rest API</title>
                <sort_order>10</sort_order>
                <privileges>
                    <admin>
                        <create>1</create>
                       <!-- <retrieve>1</retrieve>
                        <delete>1</delete>-->
                    </admin>
                   <!--  <customer>
                        <create>1</create>
                        <retrieve>1</retrieve>
                         <delete>1</delete>
                    </customer>
                     <guest>
                        <create>1</create>
                       <retrieve>1</retrieve>
                        <delete>1</delete>
                    </guest>-->
                </privileges>
                <routes>
                    <route_entity>
                        <route>/custom/createwebsite/:s</route>
                        <action_type>entity</action_type>
                    </route_entity>
                </routes>
                <versions>1</versions>
            </restapi>
        </resources>
    </api2>

模型目錄結構

應用程序\代碼\本地\自定義\ RESTAPI \型號\ API2 \ Restapi.php。 以下是文件代碼 - :

Restapi.php

class Custom_Restapi_Model_Api2_Restapi extends Mage_Api2_Model_Resource
{

}

app \ code \ local \ Custom \ Restapi \ Model \ Api2 \ Restapi \ Rest \ Admin \ V1.php下面是file-代碼:

V1.php

class Custom_Restapi_Model_Api2_Restapi_Rest_Admin_V1 extends Custom_Restapi_Model_Api2_Restapi
{
     protected function _create(){


   return  json_encode(array("testing","hello"));
}

 protected function _retrieveCollection()
{
      return  json_encode(array("testing","hello"));
 }
}

還設置了Etc /模塊配置文件。

管理員設置

  1. 我創建了OAuth角色admin。 在左側選項卡“角色Api資源”模塊設置可見並選中。

  2. 還配置了休眠消費者設置。

下面是REST API調用腳本代碼 - :

Api調用腳本代碼

$consumerKey    = 'ozr74egldg07dpxtkk9uq1o8bj6wwd65'; // from Admin Panel's &quot;REST - OAuth Consumers page&quot;
$consumerSecret = 'ozr74egldg07dpxtkk9uq1o8bj6wwd65'; // from Admin Panel's &quot;REST - OAuth Consumers page&quot;

// Set the OAuth callback URL to this script since it contains the logic
// to execute *after* the user authorizes this script to use the Coupon AutoGen API
$callbackUrl = "http://127.0.0.1/magento/testscript.php";

// Set the URLs below to match your Magento installation
$temporaryCredentialsRequestUrl = "http://127.0.0.1/mage_restapi/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
$adminAuthorizationUrl = 'http://127.0.0.1/mage_restapi/admin/oauth_authorize';
$accessTokenRequestUrl = 'http://127.0.0.1/mage_restapi/oauth/token';
$apiUrl = 'http://127.0.0.1/mage_restapi/api/rest';

session_start();

if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
    $_SESSION['state'] = 0;
    echo "try";
}

try {

    $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
    $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);

    $oauthClient->enableDebug();

    if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {

        $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
        $_SESSION['secret'] = $requestToken['oauth_token_secret'];
        $_SESSION['state'] = 1;
        header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
        exit;
    } else if ($_SESSION['state'] == 1) {
        $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
        $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
        $_SESSION['state']  = 2;
        $_SESSION['token']  = $accessToken['oauth_token'];
        $_SESSION['secret'] = $accessToken['oauth_token_secret'];
        header('Location: ' . $callbackUrl);
        exit;
    } else {  

        // We have the OAuth client and token. Now, let's make the API call.
        $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);



        // Generate coupon codes via POST
        $resourceUrl = "$apiUrl/custom";

        $oauthClient->fetch($resourceUrl, OAUTH_HTTP_METHOD_POST, array(
            'Accept' => 'application/json',
            'Content-Type' => 'application/json',
        ));


         $data= json_decode($oauthClient->getLastResponse(), true);


        echo "Data is:<br/>".$data;

    }
} catch (OAuthException $e) {

    print_r($e->getMessage());
    //echo "<br/>";
    //print_r($e->lastResponse);
}

當我嘗試訪問API時,它會要求授權

授權應用程序管理員請求訪問您的帳戶

授權申請後,您將有權訪問您的帳戶。

授權按鈕和拒絕按鈕

點擊授權按鈕錯誤後:

無效的身份驗證/錯誤請求(獲得404,預期的HTTP / 1.1 20X或重定向){“messages”:{“error”:[{“code”:404,“message”:“請求與任何路由都不匹配”。 }]}}

PHP OAuth擴展在我的OAuth設置中不支持RSA-SHA1支持

參考鏈接http://www.magentocommerce.com/knowledge-base/entry/how-to-use-extend-the-magento-rest-api-to-use-coupon-auto-generation

http://ctodilemma.com/2013/04/customising-and-extending-the-magento-rest-api/

我們只使用magento提供的函數來訪問其餘的代碼,下面是函數列表 - :

  1. _創建()
  2. _retrieve()
  3. _刪除()
  4. _retrieveCollection()
  5. _Update()
  6. _multiUpdate()
  7. _multiDelete

錯誤無效的身份驗證/錯誤請求(獲得404,預期的HTTP / 1.1 20X或重定向){“messages”:{“error”:[{“code”:404,“message”:“請求與任何路由都不匹配。 “}]}}

我已經分享了我的所有分析,但我無法訪問數據。請分享您的反饋。


Answers

您的資源url應該與api2.xml中的url對應

$resourceUrl = "$apiUrl/custom";

應該 :

$resourceUrl = "$apiUrl/custom/createwebsite/"

什麼:s $ apiUrl / custom / createwebsite / :s代表的結尾?



本身並沒有“RESTful編程”這樣的概念。它會更好地稱為RESTful範例或甚至更好的RESTful架構。它不是一種編程語言。這是一種範式。

來自維基百科

在計算中,表示性狀態轉移(REST)是用於Web開發的體系結構樣式。





php rest magento