2010-12-22 4 views
0

이 자습서를 인용으로 RestletREST WADL : 스타일 가이드 라인이나 좋은 예는 무엇입니까?

http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html

를 사용

우리는 WADL를 통해 우리의 REST 인터페이스를 문서화하는 자바 코드에 대한 좋은 자바 독을 작성하기위한 우수 사례 및 가이드 라인 (참고 참조 [1])의 많음이있다 우리는 다음과 같은 코드를 추가하고 있습니다 ...

@Override 
    protected void describeDelete(MethodInfo info) { 
     info.setDocumentation("Delete the current item."); 

     RepresentationInfo repInfo = new RepresentationInfo(); 
     repInfo.setDocumentation("No representation is returned."); 
     repInfo.getStatuses().add(Status.SUCCESS_NO_CONTENT); 
     info.getResponse().getRepresentations().add(repInfo); 
    } 

좋은 간결한 WADL의 코딩 표준이나 예제가 있습니까? e, g, 우리는 HTTP 동사 또는 URL에 암시 적으로 정보를 복제하고 싶지 않습니다.

Ref 1. Javadoc 도구에 대한 Doc 주석을 쓰는 방법. 나는 새로운 사용자 나처럼 URL을 추가하지 못할하지만 난
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

답변

0

의 지침 편안한 시스템의 일부만을 의미하는 추가 문서가 필요하면 사용자 지정 미디어 유형과 사용자 지정 링크 관계가 필요합니다.

이런 식으로 생각하면 사용자가 웹 브라우저 공급 업체에 제공하여 사용자가 회사 웹 사이트에 액세스 할 수 있었는지 생각해보십시오.