質問: お世話様です。 あるWebサイトの開発で、Webサイトとは別の注文管理システム(OMS) のWeb API をコールする要件があります。 Web API の仕様案を検討する必要があり、Rest API として設計をしています。 なにぶんはじめてなもので、べからず・ベターな方法が分からないことがあり、質問させていただきます。 --- ■想定している内容 ・接続方式 * プロトコル:HTTP * データ交換形式 : XML * 文字コード : UTF-8 * メソッド : POST * Content-Type : application/xml - Accept : application/xml -------------------------- データ交換形式はXML でメソッドはPOST になるのですが、この場合、 ・リクエストのXMLはどのようにどこに置く仕様とするものでしょうか。 * Body 内? * URL のパラメータ? POSTなのでBody内かと思っていましたが、Rest API ではURLのパラメータとして付与するという話をきいたりもして、少々迷っています ・application/xmlの場合のXMLやりとりは、XMLファイルをやりとりするのでしょうか、XML形式の文字列をやりとりするものなのでしょうか ※特に双方サーバ内にファイル出力はしません なお、コール元・先とも、Java言語です。 まず前提や想定が異なっているところもあるかもしれませんが、、少しでもご意見・ご助言いただけると大変助かります。 よろしくお願い致します。
回答: > > Rest API ではURLのパラメータとして付与するという話をきいたりもして、少々迷っています > > > URLは「リソースの場所」を表現して、そのリソースに関する情報を得たい場合は GET でリクエストをして、情報を更新したい場合は PUT でリクエストする、などのAPI設計を REST API と呼びます。 ちょっと要件が不明ですが、注文管理システムに対して、新規の注文を POST で投げるだけで、エンドポイント(URL)も固定である場合、もはや REST API とか、そういう話ではないと思います。