ペイロードとしてJSONを受け入れるPHPでRESTfulWebサービスを構築しています。さて、私の質問は、JSONリクエストが入ってくるフォーマットをユーザーにどのように正確に説明するのかということです。私はJSONを初めて使用しますが、100％把握しているとは思いません。
他のユーザーシステムは基本的に、必要なキーと値のペアを使用してデータ構造（配列など）を作成し、これをJSONでエンコードして、Webサービスに送信しますか？
文字通り、アレイがどのように見える必要があるかのコピーを提供しますか？ありがとう！
RESTのガイドラインに従い、APIのユーザーから取得する入力は、URLの一部（GETリクエストの場合。データを更新しないhttp://example.com/api/doc/1243など）であるか、POST変数（本文で送信される）である必要があります。同じURLへのHTTPリクエストの）。
したがって、ドキュメントの場合、必要なのは、エンドポイントURL（ ）、POSTを使用する必要があるというhttp://example.com/api/doc/1243事実、および変数（、、、など）を指定することだけです。次に、ユーザーは必要に応じて適切なHTTPリクエストを作成します。サーバー側では、PHPを使用しているため、配列から変数を取得します（つまり、など）。titlebodyauthor$_POST$_POST['title']$_POST['body']
Dropboxは、JSONをペイロードとして使用するRESTfulAPIの良い例です。
また、APIを文書化する方法についても良いアイデアが得られます。