MS_WebAPI

WebAPI

• TOP > インフラストラクチャ > 通信技術 > HTTP
  • WebAPI
  • HttpClientの類の使い方

概要

WebAPIに関する情報リンクを纏めています。

詳細

インターフェイス

SOAP

SOAP

• XMLであり、古い。
• 新規採用は、ほぼ、無い。

REST

REST

• HTTPメソッドのリクエストと、
• JSON、XMLのレスポンス

Swagger (OpenAPI)

Swagger (OpenAPI)

• REST の JSON 系を発展させた。
• パラメータ付きの URL テンプレート＋HTTP へのカスタム マッピング

gRPC

gRPC

• バイナリ電文（Protocol Buffers）
• IDLがあるらしい。
• 互換ライブラリが揃っている。

GraphQL

GraphQL

• データクエリとデータ操作をするリクエスト。
• 上記の結果を返す、JSON のレスポンス
• 実装は、Schemaクラスを定義し、Queryクラスに実装する。

OData

OData

• XML、XML-RPC版の GraphQL 的な位置付け。
• Dynamics（MS_Dynamics.md）系で採用されている（Graph API）。

何を選択するか？

• 好きなのを使えば良いと思いますが、以下（参考）を見て、自分は、

  • 「リクエストは、POST（form or json）
  • レスポンスは、JSON で良くない？」

  派だと思いました（≒ JSON-RPC）。

  • REST 設計に悩むようであれば、拘らず、JSON-RPCで造ってしまえば良い。
    （「WWWブラウザから、URL直打ちのGETでJSONレスポンスを確認したい。」などの要件が無ければ）
  • 何故か？と言うと、以下の辺りが根拠になっていると思います。
    • 相互運用可能なBeanが生成される仕組みがアレばイイかな？と思います。
    • コレは、RFCなどで標準化はされていませんが、JSONパーサーの仕様が、
      言語間で似通っているため、安定して出来る芸当になっているのだと思います。

• 参考

  • API 設計: gRPC、OpenAPI、REST の概要と、それらを使用するタイミング - Google Cloud Blog
  • API 設計ガイダンス - Microsoft Learn

ペイロード

• XML
  • リクエストにもXMLを使うと、SOAP
  • REST での XML の採用は減ってきている。
• JSON
  • リクエストにもJSONを使うと、JSON-RPC
• MessagePack
• Protocol Buffers
• CBOR

その他

• クロス ドメイン接続
• WebAPIの認証
• API Gateway

ツール

• cURLコマンド
• Postman

.NET開発

• HttpClientの類の使い方
• ASP.NET（MS_ASPNET.md）
  • ASP.NET Web Service
  • WCF (Windows Communication Foundation)（MS_WCF.md）
  • ASP.NET Web API

補足（最新化）: .NET 側の現在の標準は、

• REST / OpenAPI 系は ASP.NET Core の Minimal API または MVC (Web API)。 Swashbuckle は .NET 9 以降テンプレートから外れ、Microsoft.AspNetCore.OpenApi が標準。
• RPC 系は gRPC（Grpc.AspNetCore）。
• GraphQL はサードパーティの HotChocolate が事実上の標準。
• ASP.NET Web Service（.asmx）と WCF はレガシー扱い。

---

Tags: プログラミング, 通信技術, .NET開発, .NET Core, ASP.NET, ASP.NET Web API, ASP.NET SPA