2010-12-03 2 views
0

저는 REST API를 작성하고 xml 표현에 어떤 형식을 사용해야하는지 논의하고 있습니다. 집에서 정의 할 수 있지만 형식이 많이 있다는 것도 알고 있습니다. wadl은 재미있어 보이지만 그것에 대한 토론이있는 것처럼 보이며 새로운 내용이기도합니다.xml의 REST 표현

권장 사항 (권장 사항)은 무엇입니까?

답변

0

유효 XML이면 시작입니다. 간단한 REST/XML 서비스에 대한 내 일반적인 전략은 다음과 같습니다.

파싱에는 거의 항상 단일 루트 노드가 필요합니다. 결과 엘리먼트 또는 에러 엘리먼트를 포함 할 수있는 "응답" 는 예컨대 : 당신이 결과를 구조

<response> 
    <result> 
    <answer>5</answer> 
    </result> 
</response> 

방법은 당신에게 달려 있습니다. elemenets에 데이터를 CDATA (위의 그림과 같이 텍스트)로 보류 할 것인지 또는 필수 속성으로 보류 할 것인지 결정할 수 있습니다 (예 :

<answer value="5"/> 

유용한 응답에 원래 쿼리를 포함하는 것입니다 때로는 또 다른 것은, 예컨대 :

<response query="operation=add&a=2&b=3"> .. </response> 

이 뛰어난 여러 쿼리가있는 경우이 방법을 사용하면 원래 요청을 일치시킬 수 있습니다.

+0

예 유효한 XML입니다. 이것은 필수 항목입니다. – silviud

+0

내 질문이 더 관련이 있습니다 - 설명대로 표현 방법을 고안하여 REST 혜택 중 일부를 생략하거나 잘 알려진 표현을 사용하는 위험을 감수해야합니다. – silviud

+0

WADL 설명은 공식적으로 REST 서비스를 설명하는 방법이지만 XML 응답 형식은 여전히 ​​사용자가 정의한 다음 WADL 응답 표현으로 설명합니다. 서비스가 사소한 경우가 아니면 말 그대로 텍스트를 이름 리소스에 게시하거나 텍스트에서 이름 리소스를 읽는 경우 일반적으로 데이터 형식을 만들어야합니다. – andrewmu