WebAPIのレスポンスデータが200ではなく204になることについて

Question

開発環境：VisualStudio2019
フレームワーク：.NET 4.7.2
言語：VisualBasic
通信時のURL：https://localhost:44385/api/ApiTest

WEBAPIの開発をしております。
リクエストしたときに、VisualStudio上のIIS Expressを押した後のブラウザではJSONデータが表示されるのに対して、PostmanやVisualStudioの拡張機能のREST Cliant では204のNo Contentsが返ってきて、JSONデータが返ってきません。

通信はできているのですが、JSONデータを返さないのが分かりません。
リクエスト時のURLに問題はありませんが、お分かりになりましたがご教授頂けますと幸いです。

RouteConfig.vb
Public Module RouteConfig
    Public Sub RegisterRoutes(ByVal routes As RouteCollection)
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}")

        routes.MapRoute(
            name:="Default",
            url:="{controller}/{action}/{id}",
            defaults:=New With {.controller = "Home", .action = "Index", .id = UrlParameter.Optional}
        )
    End Sub
End Module

WebApiConfig.vb
Public Module WebApiConfig
    Public Sub Register(ByVal config As HttpConfiguration)
        ' Web API の設定およびサービス

        'jsonをブラウザで表示させる
        config.Formatters.JsonFormatter.SupportedMediaTypes.Add(New System.Net.Http.Headers.MediaTypeHeaderValue("text/html"))
        ' Web API ルート
        config.MapHttpAttributeRoutes()

        config.Routes.MapHttpRoute(
            name:="DefaultApi",
            routeTemplate:="api/{controller}/{id}",
            defaults:=New With {.id = RouteParameter.Optional}
        )
    End Sub
End Module

Public Class ApiTestController
        Inherits ApiController

        ' GET: api/ApiTest
        Public Function GetValues() As IEnumerable(Of String)
            Return New String() {"value1", "value2"}
        End Function

        ' GET: api/ApiTest/5
        Public Function GetValue(ByVal id As Integer) As String
            Return "value"
        End Function

        ' POST: api/ApiTest
        Public Sub PostValue(<FromBody()> ByVal value As String)

        End Sub

        ' PUT: api/ApiTest/5
        Public Sub PutValue(ByVal id As Integer, <FromBody()> ByVal value As String)

        End Sub

        ' DELETE: api/ApiTest/5
        Public Sub DeleteValue(ByVal id As Integer)

        End Sub
    End Class

Send Request
POST https://localhost:44385/api/ApiTest HTTP/1.1
content-type: application/json

{
    "name": "sample",
    "time": "Wed, 21 Oct 2015 18:27:50 GMT"
}

WEBAPIを作成する際に参考にしたサイト：
https://www.dcast01.com/vb-net-rest-api2/

Comments

[退会済みユーザー]

ASP.NET のタグを付けてください。API は ASP.NET MVC / Web API ですよね。

[退会済みユーザー]

参考にしたサイトは URL の文字列を書くだけでなく、クリックすれば飛べるようリンクを張ってください。

[退会済みユーザー]

質問者さん、無言ですが、回答したのでそれに対するフィードバックを書きましょう。役に立った/立たなかったぐらいはすぐ返せるはず。役に立たなかったなら、どこがダメだったかを書くと、より質問者さんが期待する答えに近いものが出てくるかも。とにかく無言で放置は NG です

[syoco0330]

コメントありがとうございます。
とても参考になりました。

[退会済みユーザー]

ASP.NET のタグを付けてください。API は ASP.NET MVC / Web API ですよね。

Answer 1

解決したため記入いたします。

Send RequestがPOSTに対して、ApiTestController　のGetValues()の中が返って来ると勘違いしていたことが原因。

POSTでリクエストした場合は、

        ' POST: api/ApiTest
        Public Sub PostValue(<FromBody()> ByVal value As String)
　　　　　　’ここを記入しないと200にならない
        End Sub

逆にGETでリクエストした場合は下のコードを通るのでReturnを記入する必要がある

        Public Function GetValues() As IEnumerable(Of String)
           ’ここを記入しないと200にならない 
　　　　　　Return New String() {"value1", "value2"}
        End Function

        ' GET: api/ApiTest/5
        Public Function GetValue(ByVal id As Integer) As String
           ’ここを記入しないと200にならない 
            Return "value"
        End Function

Comments

[退会済みユーザー]

POST 要求の話だとは質問には一言も書いてないですよ。

テンプレートで自動生成されたコードでは GET 要求に対するメソッド場合しか中身がないということが認識できていなかったことと、RESTful の基本を理解していないことが問題で、そこを理解しないと解決とは言えないと思いますが、理解してますでしょうか？

Answer 2

リクエストしたときに、VisualStudio上のIIS Expressを押した後のブラウザではJSONデータが表示されるのに対して、PostmanやVisualStudioの拡張機能のREST Cliant では204のNo Contentsが返ってきて、JSONデータが返ってきません。

ブラウザのアドレスバーに API の url（質問者さんのケースでは https://localhost:44385/api/ApiTest と理解）を入力して以下のように応答が返ってくるのですよね？　（注：以下の画像ではブラウザに Chrome を使っています。応答が JSON ではなく XML になる理由は後述）

であれば、Web API はちゃんと動いているので「PostmanやVisualStudioの拡張機能のREST Cliant」で 204 応答になるのはやり方の問題だと思います。

自分は「PostmanやVisualStudioの拡張機能のREST Cliant」は持ってないので、Windows 10 付属の curl と Fiddler の Composer を使って検証する例を紹介しておきます。

(1) Windows 10 付属の curl

上の画像の url に curl を使って GET 要求を出した場合。期待通り JSON 文字列が戻ってきています。

(2) Fiddler の Composer

Fiddler というのは HTTP 要求・応答をキャプチャするツールで、その中に Composer という自由に要求を出せる機能があります。それを使って上の画像の url を GET 要求したのが下の画像です。

その時の要求・応答は Inspectors ダブに切り替えて見ることができます。期待通り JSON 文字列が戻ってきています。

Fiddler は今回のような Web API の開発には必要不可欠と言っても過言ではないと思います。是非入手して使えるようになることをお勧めします。

Fiddler のお勧め
http://surferonwww.info/BlogEngine/post/2011/05/25/Recommendation-of-Fiddler.aspx

最後に、何故 Chrome を使った場合の応答が JSON ではなく XML になってしまうかですが、.NET Framework 版の ASP.NET Web API を要求する際、要求ヘッダの Accept に application/xml が含まれると応答は JSON ではなく XML になるからです。

なので、ブラウザのアドレスバーに URL を入力して GET 要求をかけた場合、Chrome, Edge, Firefox では応答が JSON ではなく XML になってしまいます。IE11 は Accept に application/xml を含まないので JSON が返ってきます。

下の画像は Chrome を使った場合の要求・応答を Fiddler で見たものです。

詳しくは以下の記事を読んでください。

Web API と要求ヘッダの application/xml
http://surferonwww.info/BlogEngine/post/2020/06/07/response-from-aspnet-web-api-and-application-xml.aspx