Question

我聘请了一名后端开发人员为我的iPhone应用程序开发REST API。我需要向他提供iPhone将要发出的所有HTTP请求的列表。是否有一个软件可以帮助规划REST API，或者我只是在带有参数和示例的普通TXT文件中写出来？

Answer 1

规划API是他/她工作的一部分，而不是你的工作，
特别是现在，从你看起来你没有这方面的经验，我绝对要求API开发人员自己规划API。

Answer 2

如果您能够向开发人员提供有关您希望传递的内容以及您希望返回的内容的每项服务的信息，那将是最好的解释，

例如，这就是如何解释服务注册设备（这是基于苹果存折服务器）。

如果您按照下面的结构进行操作，那么开发人员可以毫无问题地为您提供所需的内容。

/**
 # 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
 */

规划REST API的最佳方式

2 个答案: