의견 보내기
코드 작성 및 주석 달기
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
Cloud Endpoints Frameworks 코드를 구조화하고 주석을 추가하는 방법에 대해 설명합니다. 지원되는 주석의 전체 목록은 주석 을 참조하세요.
시작하기 전에
개발 환경을 설정합니다 .
스켈레톤 Endpoints Frameworks 예를 클론합니다.
git clone https : //github.com/GoogleCloudPlatform/java-docs-samples.git
스켈레톤 Endpoints Framework 예는 다음 위치에 있습니다.
cd appengine - java8 / endpoints - v2 - skeleton /
주석의 작동 원리를 설명하기 위해 이 문서에서는 endpoints-v2-backend
샘플을 빌드하기 위해 추가해야 하는 주석과 기타 코드를 endpoints-v2-skeleton
샘플로 보여줍니다. 결국 수정된 endpoints-v2-skeleton
샘플은 App Engine에서 Endpoints Frameworks 시작하기 에서 사용된 endpoints-v2-backend
샘플과 동일하게 동작합니다.
코드 작성 및 주석 추가
코드에 주석을 추가하려면 다음 안내를 따르세요.
디렉터리를 프로젝트의 자바 소스 디렉터리로 변경합니다(예: src/main/java/com/example/skeleton
).
다음과 같은 코드가 포함된 Message.java
라는 JavaBean 클래스 파일을 만듭니다.
스켈레톤 예시에 포함된 MyApi.java
파일을 수정합니다.
@Api
정의 주석을 다음과 같이 변경합니다.
version = "v1"
속성은 샘플 API의 버전을 지정합니다. 입력하는 값이 API로 연결되는 URL 경로의 일부가 됩니다. 버전에 관한 자세한 내용은 API 버전 관리 를 참조하세요.
MyApi.java
에 첫 번째 API 엔드포인트로 echo
메서드를 추가하고 doEcho
도우미 메서드를 추가합니다.
Echo.java
에서 가져오기를 모두 복사하여 MyApi.java
에 붙여넣습니다.
Maven
프로젝트를 빌드합니다.
mvn clean package
Gradle
프로젝트를 빌드합니다.
gradle clean build
주석 기본사항
백엔드 API에는 일반적으로 다음 세 가지 주석이 사용됩니다.
@Api
에는 백엔드 API의 구성 세부정보가 포함되어 있습니다.
@ApiMethod
는 백엔드 API의 일부인 클래스 메서드를 표시합니다 @ApiMethod
로 표시되지 않은 메서드는 클라이언트 라이브러리와 검색 문서를 생성할 때 포함되지 않습니다. @ApiMethod
주석은 특정 메서드의 API 구성을 재정의할 때도 사용할 수 있습니다.
@Named
는 매개변수가 항목 유형이 아닌 한, 서버 측 메서드로 전달되는 모든 매개변수에 추가되어야 합니다.
Endpoints Frameworks 주석의 전체 목록은 주석 및 구문 을 참조하세요.
다음 단계
의견 보내기
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스 에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스 에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책 을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-09-01(UTC)
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"번역 문제"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"기타"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"이해하기 쉬움"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"문제가 해결됨"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"기타"
}]
의견을 전달하고 싶나요?
{"lastModified": "\ucd5c\uc885 \uc5c5\ub370\uc774\ud2b8: 2024-09-01(UTC)"}
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["번역 문제","translationIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2024-09-01(UTC)"]]