編寫程式碼並加上註解

本頁說明如何建構 Cloud Endpoints Frameworks 程式碼並加上註解。如需查看所有支援的註解，請參閱註解一文中的完整清單。

事前準備

  1. 設定您的開發環境。

  2. 複製 Endpoints Frameworks 基本架構範例：

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

  3. Endpoints Frameworks 基本架構範例位於以下位置：

     cd appengine-java8/endpoints-v2-skeleton/

本文件使用 endpoints-v2-backend 範例來展示註解以及其他程式碼，以協助解釋註解的運作，您必須將這些註解及程式碼加入 endpoints-v2-skeleton 範例以進行建構。最後，修改後的 endpoints-v2-skeleton 範例的行為會與 endpoints-v2-backend 範例一樣，後者用於開始在 App Engine 上使用 Endpoints Frameworks 的相關文章。

建立與註解程式碼

如要為您的程式碼加上註解：

  1. 將目錄更改為專案的 Java 來源目錄，例如：src/main/java/com/example/skeleton。
  2. 建立名為 Message.java 的 JavaBean 類別檔案，其中包含以下程式碼： 
    public class Message {

  private String message;

  public String getMessage() {
    return this.message;
  }

  public void setMessage(String message) {
    this.message = message;
  }
}
  3. 編輯基本架構範例中包含的 MyApi.java 檔案，並將 @Api 定義註解改成以下內容： 
    @Api(
    name = "echo",
    version = "v1",
    namespace =
    @ApiNamespace(
        ownerDomain = "echo.example.com",
        ownerName = "echo.example.com",
        packagePath = ""
    ),
    // ...
)

    version = "v1" 屬性會指定 API 範例的版本，您所輸入的值將成為 API 網址路徑的一部分。如要進一步瞭解版本，請參閱處理 API 版本管理一文。

  4. 新增以下的 echo 方法做為您的第一個 API 端點，以及新增 doEcho 輔助程式方法至您的 MyApi.java。 
    @ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
     
    private Message doEcho(Message request, Integer n) {
  Message response = new Message();
  if (n != null && n >= 0) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < n; i++) {
      if (i > 0) {
        sb.append(' ');
      }
      sb.append(request.getMessage());
    }
    response.setMessage(sb.toString());
  }
  return response;
}
  5. 複製 Echo.java 的所有匯入內容，並將其貼到 MyApi.java 中。

  6. Maven

    建構專案：

    mvn clean package

    Gradle

    建構專案：

    gradle clean build

註解基本原則

後端 API 常用的註解有以下三種：

  • @Api 包含後端 API 的設定詳細資料。
  • @ApiMethod 是用來標示屬於後端 API 一部分的類別方法。當您產生用戶端程式庫和探索文件時，未標示 @ApiMethod 的方法不會包含在內。@ApiMethod 註解也可用來覆寫特定方法的 API 設定。
  • @Named 必須加到傳送給伺服器端方法的所有參數中 (除非參數屬於實體類別)。

如需查看所有的 Endpoints Frameworks 註解，請參閱註解和語法一文中的完整清單。

後續步驟