0

私はバックエンド開発者を雇って、iPhoneアプリ用のRESTAPIを開発しました。iPhoneが行うすべてのHTTPリクエストのリストを彼に提供する必要があります。REST APIの計画に役立つソフトウェアはありますか、それともパラメーターと例を含むプレーンなTXTファイルに書き出すだけですか？

4

2 に答える 2

2

APIの計画は彼/彼女の仕事の一部であり、あなたの仕事ではありません。
特に、この分野での経験がないように見えるので、API開発者自身にAPIの計画を依頼します。

于 2012-10-23T21:16:33.263 に答える
1

開発者に、渡されると予想されるものと返されると予想されるものを含む各サービスに関する情報を提供できれば、最もよく説明されます。

たとえば、これはデバイスを登録するためのサービスを説明する方法です（これはアップルの通帳サーバーに基づいています）。

以下のような構造に従えば、開発者は必要なものを正確に提供することに問題はありません。

/**
 # Registration
 # register a device to receive push notifications for a pass
 #
 # POST /v1/devices/<deviceID>/registrations/<typeID>/<serial#>
 # Header: Authorization: ApplePass <authenticationToken>
 # JSON payload: { "pushToken" : <push token, which the server needs to send push notifications to this device> }
 #
 # Params definition
 # :device_id      - the device's identifier
 # :pass_type_id   - the bundle identifier for a class of passes
 # :serial_number  - the pass' serial number
 # :pushToken      - the value needed for the Notification service
 #
 # server action: if the authentication token is correct, associate the given push token and device identifier with this pass
 # server response:
 # --> if registration succeeded: 201
 # --> if this serial number was already registered for this device: 304
 # --> if not authorized: 401
 */
于 2012-10-23T21:14:34.633 に答える