2016-09-20 6 views
0

私はphpで構築されたサイトを持っており、他のサイトがこれらのサービスを利用できるように、ユーザー登録フォーム(および関連する機能)を公開したいと考えています。 RESTfulなAPIを使用してこれらの機能を開きたいのですが、これについてはどうすればよいでしょうか?各言語のドキュメントを作成する必要がありますか?phpはjson経由でrubyと話すことができますか?

答えて

0

これらの機能をRESTfulなAPIを使用して開きたいのですが、これを行うにはどうすればよいでしょうか?

RESTful APIは、さまざまなアプリケーションがシステムと通信できるようにするための非常に良いアイデアです。

各言語のドキュメントを作成する必要がありますか?

それはあなたがこれらの言語を知っていて、それらに対してコーディングすることができれば、異なる言語でのいくつかのコード例を提示することは常に良いことだが、それは必須ではないのです。それぞれのリソースとその方法(つまり、(S)CRUDの可能性が最も高い)とレスポンス構造を文書化することに集中する必要があります。

+0

それぞれのリソースとその方法(つまり、(S)CRUDの可能性が高い)とは何ですか?また、レスポンス構造は何ですか?したがって、私の文書には私のサイト(PHP)と話すために必要な情報が表示され、情報を入力するのは相手側の責任になります。 – storno88

+0

RESTful APIのヒントはリソースです。だから、あなたはユーザーのリソースを持っているとしましょう。あなたのAPIは、ユーザーのために以下のアクションをさせるかもしれません: 検索/インデックス(全ユーザー表示) ユーザーPOST /ユーザーの作成 ユーザーの取得GET/users/{user_id} ユーザーPUT/users/{user_id}の更新 削除このメソッドのそれぞれでは、作成にメール、ユーザー名、日付を渡す必要があるなど、いくつかのパラメータが必要になることがあります。そうしないとAPIが400 Bad Requestを返します。 APIドキュメントで扱うべきこと。 –

関連する問題