2011-02-18 2 views
2

ASP.NET과 OpenRasta를 사용하여 ReST Web Services를 만들고 있습니다.ReST 웹 서비스 설명서/WADL 자동 생성

있는 우리에게 도움이 될 수있는 도구가 있습니까 :

  • 만들 WADL는

  • 파일 및/또는 각 자원에 대한 지원 자원/HTTP 방법을 설명한 기능하는 비슷한 사람이 읽을 수있는 API 문서를 생성은, 등?

+0

WCF로 ReST를 할 때 무료로 얻을 수 있습니다. http://msdn.microsoft.com/en-us/library/ee230442.aspx – OliviuG

답변

0

OpenRasta를 들어, (예 /에서는 MyResource의 $ 도움으로) 자원에 대해 정의 도움이 같은 URI를 가지도록 UriDecorator를 사용할 수있을 것입니다. 그런 다음 구문 분석을하기 전에 URI를 다시 작성하여 쉽게 문서화하고 URI를 파싱하고 리소스 유형을 찾고/help/{resourcetype}로 다시 작성하십시오.

거기에서 도움말 시스템 용 리소스를 등록하십시오. ResourceSpace .Has.ResourcesOfType() .AtUri ("/ 도움말/{resourceType에서}") .HandledBy() .RenderedByXxx는()

그런 다음 당신은 자원에 대한 문서를 반환하는 핸들러를 만들 수 있습니다. 예를 들어 IOperationCreator 서비스를 사용하여 사용할 수있는 http 메서드 메서드 및 입력 인수를 확인하고 ICodecRepository를 사용하여 어떤 미디어 유형이 입력으로 받아 들여 지는지 확인할 수 있습니다. 또한 잠재적으로 코덱을 호출하여 미디어 유형 직렬화를 그것의 html 친절한 전망을 생성.

분명히 우리가 다음 버전을 위해 작업 할 영역입니다.

1

외모는 REST Describe & Compile입니다. WADL 개발자 사이트 마크 해들리 에

는 WADL2Java라는 명령 줄 도구를 유지하고있다. REST의 야심 찬 목표 설명 & 컴파일은 WADL2Anything의 정렬을 제공합니다.

  • 는 완전히 대화 형 방식으로 새로운 WADL 파일을 생성합니다 : 그래서 REST는 컴파일이하는 &이 있다는 것입니다 설명 무엇인지.
  • 기존 WADL 파일을 업로드하고 편집 할 수 있습니다.
  • WADL 파일을 다양한 프로그래밍 언어로 소스 코드로 컴파일 할 수 있습니다.
+0

답장과 링크를 보내 주셔서 감사합니다. 실제로 흥미 롭지 만 완전히 상호 작용하는 방식이 아닌 WADL (또는 동등한 HTML)을 자동으로 생성하는 도구 (예 : 소스 코드 수준에서 REST 메서드를 꾸미기)가있었습니다. – OliviuG

+0

wadl 파일에서 코드를 생성하면 커플 링이 많이 도입되어 휴식의 원칙이 깨질 수 있습니다. – SerialSeb