Swashbuckle.AspNetCoreで応答コード200を非表示にするにはどうすればよいですか?

ilMattion

チャオ、

私は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]

編集
0

コメントを追加

0

関連記事

分類Dev

ASP.NET Core Swagger(Swashbuckle.AspNetCore)でコントローラーの説明を定義するにはどうすればよいですか?

分類Dev

Swagger + Swashbuckleでエンドポイントを表示するにはどうすればよいですか?

分類Dev

承認を使用するようにSwashBuckle.AspNetCore.Swaggerを設定するにはどうすればよいですか?

分類Dev

Swashbuckle.AspNetCoreを使用して、FromBodyパラメーターのフォームを提供するにはどうすればよいですか?

分類Dev

Swagger UIでSwashbuckleでポート443を使用するにはどうすればよいですか?

分類Dev

Swagger、Swashbuckle、Swashbuckle UIとは

分類Dev

Swagger、Swashbuckle、Swashbuckle UIとは

分類Dev

SwashbuckleでAPIの説明を追加するにはどうすればよいですか?

分類Dev

Swashbuckleのモデルで使用されているカスタム注釈を表示するにはどうすればよいですか?

分類Dev

SwashBuckleを使用してデフォルトの応答コンテンツタイプを設定または削除するにはどうすればよいですか

分類Dev

SwashbuckleでPOSTとPUTの必須フィールドを変更するにはどうすればよいですか?

分類Dev

dotnetcore 3.0でボディコンテンツが必要であることをSwashbuckle 5に伝えるにはどうすればよいですか?

分類Dev

Swashbuckle SwaggerResponseRemoveDefaults属性は、Swaggerに200の成功応答を追加します

分類Dev

ボディコンテンツが必要であることをSwashbuckleに伝えるにはどうすればよいですか?

分類Dev

SwashbuckleでSwaggerUIをバージョン別にグループ化するにはどうすればよいですか?

分類Dev

実際に送信する必要のあるフィールドのみを使用してSwashbuckleパラメータオブジェクトを表示するにはどうすればよいですか?

分類Dev

SwashbuckleのXMLドキュメントから列挙型の説明を生成するにはどうすればよいですか?

分類Dev

VersionByNamespaceConventionを使用しているときに、Asp.net Core 3.1でSwashbuckleを機能させるにはどうすればよいですか?

分類Dev

Swashbuckle.AspNetCoreエラー応答モデルを説明する方法は?

分類Dev

Swashbuckleに日付付き(時間なし)のSwaggerプロパティを生成させるにはどうすればよいですか?

分類Dev

SwaggerGenの動的に作成された定義の代わりに、SwashbuckleのSwaggerUIを使用して静的なswagger.jsonファイルを表示するにはどうすればよいですか?

分類Dev

生成されたSwaggerファイルに200OK応答を自動的に追加するSwashbuckle

分類Dev

Asp.netコアにSwashbuckleを使用して、生成されたモデルリストにモデルを追加するにはどうすればよいですか?

分類Dev

Asp.netコアにSwashbuckleを使用して、生成されたモデルリストにモデルを追加するにはどうすればよいですか?

分類Dev

OWINを使用してWebApi2用にSwashbuckleで生成されたSwaggerドキュメントにクラスとプロパティの説明を含めるにはどうすればよいですか?

分類Dev

1つのエンドポイントを指すSwashbuckleドキュメントパスに複数のアクションを追加するにはどうすればよいですか?

分類Dev

SwashBuckleはエラー時の応答本文を定義します

分類Dev

別のプロジェクト内からAPIが提供されている場合、Swashbuckle / SwaggerworkでURLパスを作成するにはどうすればよいですか?

分類Dev

投稿のステータス200応答コードをApacheがURLに返すようにするにはどうすればよいですか?

Related 関連記事

  1. 1

    ASP.NET Core Swagger(Swashbuckle.AspNetCore)でコントローラーの説明を定義するにはどうすればよいですか?

  2. 2

    Swagger + Swashbuckleでエンドポイントを表示するにはどうすればよいですか?

  3. 3

    承認を使用するようにSwashBuckle.AspNetCore.Swaggerを設定するにはどうすればよいですか?

  4. 4

    Swashbuckle.AspNetCoreを使用して、FromBodyパラメーターのフォームを提供するにはどうすればよいですか?

  5. 5

    Swagger UIでSwashbuckleでポート443を使用するにはどうすればよいですか?

  6. 6

    Swagger、Swashbuckle、Swashbuckle UIとは

  7. 7

    Swagger、Swashbuckle、Swashbuckle UIとは

  8. 8

    SwashbuckleでAPIの説明を追加するにはどうすればよいですか?

  9. 9

    Swashbuckleのモデルで使用されているカスタム注釈を表示するにはどうすればよいですか?

  10. 10

    SwashBuckleを使用してデフォルトの応答コンテンツタイプを設定または削除するにはどうすればよいですか

  11. 11

    SwashbuckleでPOSTとPUTの必須フィールドを変更するにはどうすればよいですか?

  12. 12

    dotnetcore 3.0でボディコンテンツが必要であることをSwashbuckle 5に伝えるにはどうすればよいですか?

  13. 13

    Swashbuckle SwaggerResponseRemoveDefaults属性は、Swaggerに200の成功応答を追加します

  14. 14

    ボディコンテンツが必要であることをSwashbuckleに伝えるにはどうすればよいですか?

  15. 15

    SwashbuckleでSwaggerUIをバージョン別にグループ化するにはどうすればよいですか?

  16. 16

    実際に送信する必要のあるフィールドのみを使用してSwashbuckleパラメータオブジェクトを表示するにはどうすればよいですか?

  17. 17

    SwashbuckleのXMLドキュメントから列挙型の説明を生成するにはどうすればよいですか?

  18. 18

    VersionByNamespaceConventionを使用しているときに、Asp.net Core 3.1でSwashbuckleを機能させるにはどうすればよいですか?

  19. 19

    Swashbuckle.AspNetCoreエラー応答モデルを説明する方法は?

  20. 20

    Swashbuckleに日付付き(時間なし)のSwaggerプロパティを生成させるにはどうすればよいですか?

  21. 21

    SwaggerGenの動的に作成された定義の代わりに、SwashbuckleのSwaggerUIを使用して静的なswagger.jsonファイルを表示するにはどうすればよいですか?

  22. 22

    生成されたSwaggerファイルに200OK応答を自動的に追加するSwashbuckle

  23. 23

    Asp.netコアにSwashbuckleを使用して、生成されたモデルリストにモデルを追加するにはどうすればよいですか?

  24. 24

    Asp.netコアにSwashbuckleを使用して、生成されたモデルリストにモデルを追加するにはどうすればよいですか?

  25. 25

    OWINを使用してWebApi2用にSwashbuckleで生成されたSwaggerドキュメントにクラスとプロパティの説明を含めるにはどうすればよいですか?

  26. 26

    1つのエンドポイントを指すSwashbuckleドキュメントパスに複数のアクションを追加するにはどうすればよいですか?

  27. 27

    SwashBuckleはエラー時の応答本文を定義します

  28. 28

    別のプロジェクト内からAPIが提供されている場合、Swashbuckle / SwaggerworkでURLパスを作成するにはどうすればよいですか?

  29. 29

    投稿のステータス200応答コードをApacheがURLに返すようにするにはどうすればよいですか?

ホットタグ

アーカイブ