WebAPI

「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

• 戻る
  • 通信技術 > HTTP
  • その他、開発の色々

目次 †

概要 †

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

詳細 †

インターフェイス †

SOAP †

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

REST †

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

Swagger (OpenAPI) †

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

gRPC †

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

GraphQL †

• データクエリとデータ操作をするリクエスト。
• 上記の結果を返す、JSONのレスポンス

• 実装は、Schemaクラスを定義し、Queryクラスに以下を実装する。

OData †

• XML、XML-RPC版のGraphQL
• Dynamics系で採用されている（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
    https://cloud.google.com/blog/ja/products/api-management/understanding-grpc-openapi-and-rest-and-when-to-use-them
  • API 設計ガイダンス - Best practices for cloud applications | Microsoft Docs
    https://docs.microsoft.com/ja-jp/azure/architecture/best-practices/api-design

ペイロード †

XML †

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

JSON †

リクエストにもJSONを使うと、JSON-RPC

MessagePack †

Protocol Buffers †

CBOR †

その他 †

クロス ドメイン接続 †

WebAPIの認証 †

API Gateway †

ツール †

cURLコマンド †

Postman †

.NET開発 †

HttpClientの類の使い方 †

ASP.NET †

ASP.NET Web Service †

WCF (Windows Communication Foundation) †

ASP.NET Web API †

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