提供可执行示例
提供可执行示例,用户可以直接在其终端中键入以查看 API 调用。在最大程度上,这些示例应该逐字可用,以最大限度地减少用户尝试 API 所需的工作量,例如:
$ export TOKEN=... # acquire from dashboard
$ curl -is https://$TOKEN@service.com/users
如果您使用 prmd 生成 Markdown 文档,您将免费获得每个端点的示例。
提供可执行示例,用户可以直接在其终端中键入以查看 API 调用。在最大程度上,这些示例应该逐字可用,以最大限度地减少用户尝试 API 所需的工作量,例如:
$ export TOKEN=... # acquire from dashboard
$ curl -is https://$TOKEN@service.com/users
如果您使用 prmd 生成 Markdown 文档,您将免费获得每个端点的示例。