部署及測試 API

本頁面說明如何部署 API。

事前準備

部署 API

您可以使用 App Engine Apache MavenGradle 外掛程式部署 API。如要在實際工作的 App Engine 標準環境中部署 API,請使用下列外掛程式指令:

  1. 使用下列外掛程式指令:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. 等待部署完成。
  3. 傳送測試要求至您部署的 API,例如使用 curl

    curl \
        -H "Content-Type: application/json" \
        -X POST \
        -d '{"message": "echo"}' \
        "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"
    

    回應會與下列內容相似:

    {
      "message": "echo echo"
    }
    

如果您未取得成功的回應,請參閱排解回應錯誤一文。

部署至多個應用程式版本

要瞭解如何進行 API 版本管理,以及如何部署到版本,請參閱處理 API 版本管理一文。

在本機執行與測試 API 後端

本機測試 API:

  1. 在專案的根目錄中建構專案,例如:

    Maven

    mvn clean package

    Gradle

    gradle clean build
  2. 啟動 App Engine 開發伺服器,例如:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun
  3. 送出 API 要求,進行 API 測試。例如使用 curl

    curl \
        -H "Content-Type: application/json" \
        -X POST \
        -d '{"message": "echo"}' \
        "${HOST}/_ah/api/echo/v1/echo?n=2"
    

透過不同的路徑提供 API

如要透過不同的路徑提供 API,請變更 web.xml 檔案 EndpointsServlet 部分中的 url-pattern,然後重新部署 API。例如:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

新增 API 管理

Endpoints Frameworks 提供 API 管理功能,例如:

如要讓 Endpoints Frameworks 能夠管理 API,您必須如新增 API 管理一文所述,產生及部署說明 API 的 OpenAPI 文件。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁