5

ServiceStackベースのWebサービスを文書化するためのオプションは何ですか。1行の文字列については話していません。

詳細(長くなる可能性があります)、戻り値の種類、考えられるHTTP応答、詳細な例の追加などを文書化できるようにしたいと思います。

ServiceStackでこれをサポートしていますか(見つかりませんでした)?誰かが他の方法で問題を解決していない場合。

4

2 に答える 2

4

リクエスト DTO に [Api] および [ApiMember] 属性を関連付けることで、各 Web サービスのメタデータの説明を提供できます。この情報は、動的メタデータ ページに表示されます。

もう 1 つのオプションは、単純に独自の動的 HTML ページを作成することです。これは、ServiceStack を使用すると、文字列 (HTML マークアップを含む) を返すだけで実行できます。このルートに進むと、グローバルなEndpointHost.ServiceOperationsプロパティを使用してサービス タイプのメタデータにアクセスできます。

また、C# で html を動的に生成することが好みでない場合は、組み込みのRazor Markdown 形式を使用して html を生成することもできます。これにより、html の生成が非常に快適になります:)

于 2011-08-26T02:07:21.287 に答える