사용자 지정 Server-Side REST 엔드포인트 구현

아티클
08/24/2015

적용 대상: Windows Azure Pack

서버 쪽은 데이터를 검색하고 작업을 수행하기 위해 클라이언트 쪽에서 호출하는 REST API 집합을 제공합니다. 이러한 두 유형의 작업은 일반적으로 백 엔드를 호출하여 실제 데이터를 얻거나 실제 작업을 수행합니다. API를 구현하는 컨트롤러는 일반적으로 JSON을 반환하는 ASP.NET MVC 컨트롤러이며 백 엔드는 일반적으로 서비스 관리 API이지만 ASP.NET MVC 웹 사이트에서 액세스할 수 있는 다른 서비스일 수 있습니다.

중요

헬로 월드 샘플은 샘플 서버 쪽 구현을 제공합니다.

클라이언트 쪽과 서버 쪽은 모두 동일한 Visual Studio 프로젝트에 상주할 수 있으며 동일한 관리 포털에 배포됩니다.

컨트롤러 클래스

컨트롤러 클래스는 ASP.NET MVC 표준 추상 클래스 컨트롤러 또는 AsyncController 중 하나의 인스턴스입니다. 일반적으로 보안 연결만 허용되도록 [RequireHttps] 특성, 응답 캐싱을 허용하지 않는 [OutputCache] 및 다음 오류 처리 섹션에 설명된 [PortalExceptionHandler]로 표시됩니다. 피싱 공격을 방지하기 위해 컨트롤러의 메서드는 [HttpPost]로 표시됩니다. HTTP POST 요청을 허용하면서 HTTP GET 요청을 허용하지 않습니다. 클라이언트 쪽 프레임워크와 서버 쪽 프레임워크 모두 클라이언트 쪽 프레임워크의 Grid 위젯과의 상호 작용이 필요한 경우를 제외하고 서버와 클라이언트 쪽이 서로 통신하는 방식에 제한을 두지 않습니다. 이 경우 다음 데이터 세트 반환 섹션을 참조하세요.

데이터 세트 반환

데이터 세트는 UI에서 일반적으로 목록(그리드 보기)에 표시할 데이터 목록입니다. 클라이언트 쪽 프레임워크가 이를 검색하고 표에 표시하는 것을 처리한다는 측면에서 표준 회신과는 다릅니다. 메서드가 일반적으로 UI에 목록으로 표시되는 데이터 세트를 반환하는 경우 다음 예제와 같이 Controller.JsonDataSet 메서드를 사용하는 것이 좋습니다.

return this.JsonDataSet(listOfData);

그러면 클라이언트 쪽 프레임워크에서 처리하는 데 적합한 JSON 래퍼에 listOfData 데이터 세트가 자동으로 래핑됩니다. 클라이언트 쪽 구현에 대한 자세한 내용은 Windows Azure Pack 관리 포털 확장에서 그리드를 표시하는 방법을 참조하세요.

명령 수행

컨트롤러에서 명령을 수행하는 메서드는 일반적으로 작업이 작동했음을 보여 주는 JSON 개체를 반환합니다. 이는 부울을 나타내는 성공만큼 간단하거나 작업의 결과로 변경된 데이터만큼 복잡할 수 있습니다. 클라이언트 또는 서버 쪽 프레임워크에서 실제로 필요한 것은 없습니다.

오류 처리

컨트롤러에서 throw되는 예외는 일반적으로 추가 작업 또는 후속 작업을 위해 사용자에게 표시되어야 합니다. 서버 쪽에서 이 작업을 수행하는 가장 쉬운 방법은 클래스에 [PortalExceptionHandler] 특성을 적용하는 것입니다. PortalException 유형의 예외는 올바르게 모델링된 JSON으로 변환되고, 적절한 HTTP 오류 코드가 설정되며, 오류 알림과 함께 쉽게 표시할 수 있도록 클라이언트 쪽으로 반환됩니다. [PortalExceptionHandler] 특성과 함께 오류 발생시 반환된 JSON의 예는 다음과 같습니다.

{
  "message": "Fake Error",
  "ErrorMessage": "Fake Error",
  "httpStatusCode": "InternalServerError",
  "operationTrackingId": null,
  "stackTrace": null,
}

사용자에게 내부 세부 정보가 노출되지 않도록 다른 모든 유형의 예외가 빈 HTTP 500 오류로 표시됩니다. 또한 확장이 실행 중인 포털에 DevelopmentMode가 true로 설정된 경우에만 스택 추적이 전송됩니다. 관리 포털의 web.config 파일에서 변경할 수 있습니다. 자세한 내용은 API 호출에서 반환된 오류에 대한 섹션 UI를 참조하세요.

참고 항목

Azure Pack 관리 포털 사용자 인터페이스 확장 Windows
Windows Azure Pack 관리 포털 확장에 그리드를 표시하는 방법
Windows Azure Pack 관리 포털 확장 디버깅

다음을 통해 공유