ASP.NETとOpenRastaを使用してReSTWebサービスを作成しています。
私たちを助けることができるツールはありますか?
WADLファイルを作成する
または/および各リソースでサポートされているリソース/HTTPメソッドなどを記述したものと同様の人間が読めるAPIドキュメントを作成しますか?
ASP.NETとOpenRastaを使用してReSTWebサービスを作成しています。
私たちを助けることができるツールはありますか?
WADLファイルを作成する
または/および各リソースでサポートされているリソース/HTTPメソッドなどを記述したものと同様の人間が読めるAPIドキュメントを作成しますか?
RESTのDescribe&Compileでうまくいくようです。
WADL開発者サイトで、MarcHadleyはWADL2Javaという名前のコマンドラインツールを管理しています。REST describe&Compileの野心的な目標は、一種のWADL2Anythingを提供することです。つまり、REST describe&Compileが行うことは、次のことです。
- 完全にインタラクティブな方法で新しいWADLファイルを生成します。
- 既存のWADLファイルをアップロードおよび編集できます。
- WADLファイルをさまざまなプログラミング言語のソースコードにコンパイルできます。
OpenRastaの場合、UriDecoratorを使用して、リソース(/ myResource $ helpなど)にヘルプのようなURIを定義することができます。次に、URIを書き換えてから、簡単に文書化できるものに解析し、uriを解析し、リソースタイプを見つけて、/ help/{resourcetype}に書き換えることができます。
そこから、ヘルプシステムのリソースを登録します。ResourceSpace.Has.ResourcesOfType().AtUri( "/ help / {resourceType}").HandledBy().RenderedByXxx()
次に、ハンドラーを作成して、リソースに関するドキュメントを返すことができます。たとえば、IOperationCreatorサービスを使用して、使用可能なhttpメソッドと入力引数を確認し、ICodecRepositoryを使用して、入力として受け入れられるメディアタイプ、およびコーデックを呼び出してメディアタイプのシリアル化がどのようになるかを確認できます。それのhtmlフレンドリーなビューを生成します。
これは間違いなく、次のバージョンで取り組む予定の領域です。