코드 작성 및 주석 달기

Cloud Endpoints Frameworks 코드를 구조화하고 주석을 추가하는 방법에 대해 설명합니다. 지원되는 주���의 전체 목록은 주석을 참조하세요.

시작하기 전에

  1. 개발 환경을 설정합니다.

  2. 스켈레톤 Endpoints Frameworks 예를 클론합니다.

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

  3. 스켈레톤 Endpoints Framework 예는 다음 위치에 있습니다.

     cd appengine-java8/endpoints-v2-skeleton/

주석의 작동 원리를 설명하기 위해 이 문서에서는 endpoints-v2-backend 샘플을 빌드하기 위해 추가해야 하는 주석과 기타 코드를 endpoints-v2-skeleton 샘플로 보여줍니다. 결국 수정된 endpoints-v2-skeleton 샘플은 App Engine에서 Endpoints Frameworks 시작하기에서 사용된 endpoints-v2-backend 샘플과 동일하게 동작합니다.

코드 작성 및 주석 추가

코드에 주석을 추가하려면 다음 안내를 따르세요.

  1. 디렉터리를 프로젝트의 자바 소스 디렉터리로 변경합니다(예: 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로 연결되는 URL 경로의 일부가 됩니다. 버전에 관한 자세한 내용은 API 버전 관리를 참조하세요.

  4. MyApi.java에 첫 번째 API 엔드포인트로 echo 메서드를 추가하고 doEcho 도우미 메서드를 추가합니다. 
    @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 주석의 전체 목록은 주석 및 구문을 참조하세요.

다음 단계