チャオ、
私はasp.netWeb APIコア(ターゲットフレームワーク.NET Core 2.1)に取り組んでいます。Swagger仕様を使用してAPIを文書化しています。Swashbuckle.AspNetCoreライブラリを使用することにしました。
次のような簡単な作成アクションが1つあります。
/// <summary>
/// My summary
/// </summary>
/// <remarks>My remarks</remarks>
/// <param name="value">value</param>
/// <response code="201">Created</response>
/// <response code="400">Data not valid</response>
/// <response code="500">Internal Server Error</response>
[HttpPost]
public IActionResult Post([FromBody, BindRequired] EntityDto value)
{
...
}
問題は、生成したswagger.jsonが自動的に「200応答」を作成したことです。しかし、私のアクションはエンティティのみを作成するため、201応答のみを返します。これは次のjsonフラグメントです:
{
...
"responses": {
"200": {
"description": "Success"
},
"201": {
"description": "Created"
},
"400": {
"description": "Data not valid"
},
"500": {
"description": "Internal Server Error"
}
}
...
}
インターネットでのサーフィンSwaggerResponseRemoveDefaults属性を見つけましたが、フルフレームワークプロジェクトでのみサポートされているようです。
200の応答を削除するにはどうすればよいですか?
デフォルトの応答コードをswaggerに含めないために、可能な戻りコードを宣言できます
/// <summary>
/// My summary
/// </summary>
/// <remarks>My remarks</remarks>
/// <param name="value">value</param>
/// <returns>A newly created TodoItem</returns>
/// <response code="201">Created</response>
/// <response code="400">Data not valid</response>
/// <response code="500">Internal Server Error</response>
[HttpPost]
[ProducesResponseType(201)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public void Post([FromBody] string value)
{
}
この記事はインターネットから収集されたものであり、転載の際にはソースを示してください。
侵害の場合は、連絡してください[email protected]
コメントを追加