0

モデルを返すエンドポイントの場合、 を使用しResponseTypeAttributeて、返されるデータがどのようになるかをヘルプ ページのドキュメントに伝えることができます。

/// <summary>
/// returns the specified Foo.
/// </summary>
[ResponseType(typeof(FooModel))]
[HttpGet]
[Route("~/api/foos/{fooId}")]
public async Task<IHttpActionResult> GetFoo(int fooId)
{
    ...
}

これにより、このエンドポイントがどのように動作するかを説明する Api ヘルプ ページの適切なエントリが作成されます。

特定のエンドポイントがアプリケーション/zip バイナリ ストリームを返すことを文書化したいと考えています。どうやってやるの？

4

1 に答える 1

1

APIエンドポイントがzipファイルを返すことがすでにわかっている場合は、ハードコードされたapplication/octet-stream.

content-type = "application/octet-stream"
于 2017-11-30T19:25:00.167 に答える