爪子文档存储库?
Paw Document Repository?
我仍在为如何使用和组织 Paw 文件(*.paw
文档)而苦苦挣扎,尤其是作为 API 消费者。是否更聪明:
按 项目 组织(即项目 A 使用这些特定的 API 调用,因此为该 project/client); 或
按API服务组织(即定义各种MailChimp端点的MailChimp.paw
文档,然后为每个项目添加新环境消耗 MailChimp API)?
(附带说明一下,如果有一个 public 存储库可以为流行的 API 共享 .paw 文件,那就太好了!)
没有规则,您可以根据您的用例组织内容,但我建议围绕 API 组织文件,因此所有文件都围绕给定的 API 排序,如下它的标准分组请求取决于 API 所服务的资源。一棵树的例子是:
My-Blog-API.爪子
- 用户(一组)
- 获取一个用户 (GET /users/:id)
- 创建用户(POST /users)
- 篇(一组)
- 获取文章列表(GET /articles)
- 获取一篇文章 (GET /articles/:id)
- 创建文章(POST /文章)
这样您的文档就可以紧密遵循 API 的语义。此外,它允许很好地组织您的 Environments,例如存储您的 API 的基础 URL 或用户 credentials/access 令牌。
不过,也许我会保留一个 "Related" 文件夹,用于调用 API 调用所需的第 3 方服务。例如,您可能想要调用 Twitter API 以获取访问令牌,然后您将传递给 API 以获得 "login with Twitter" 功能。
- 相关(一组)
- 推特(一组)
- 使用 Twitter 登录(GET https://api.twitter.com/login – 我不知道确切的内容 URL)
(另外,感谢创建 public 存储库的想法,一些人在他们的网站上共享了 Paw collections,但它会很好!)
我仍在为如何使用和组织 Paw 文件(*.paw
文档)而苦苦挣扎,尤其是作为 API 消费者。是否更聪明:
按 项目 组织(即项目 A 使用这些特定的 API 调用,因此为该 project/client); 或
按API服务组织(即定义各种MailChimp端点的
MailChimp.paw
文档,然后为每个项目添加新环境消耗 MailChimp API)?
(附带说明一下,如果有一个 public 存储库可以为流行的 API 共享 .paw 文件,那就太好了!)
没有规则,您可以根据您的用例组织内容,但我建议围绕 API 组织文件,因此所有文件都围绕给定的 API 排序,如下它的标准分组请求取决于 API 所服务的资源。一棵树的例子是:
My-Blog-API.爪子
- 用户(一组)
- 获取一个用户 (GET /users/:id)
- 创建用户(POST /users)
- 篇(一组)
- 获取文章列表(GET /articles)
- 获取一篇文章 (GET /articles/:id)
- 创建文章(POST /文章)
这样您的文档就可以紧密遵循 API 的语义。此外,它允许很好地组织您的 Environments,例如存储您的 API 的基础 URL 或用户 credentials/access 令牌。
不过,也许我会保留一个 "Related" 文件夹,用于调用 API 调用所需的第 3 方服务。例如,您可能想要调用 Twitter API 以获取访问令牌,然后您将传递给 API 以获得 "login with Twitter" 功能。
- 相关(一组)
- 推特(一组)
- 使用 Twitter 登录(GET https://api.twitter.com/login – 我不知道确切的内容 URL)
- 推特(一组)
(另外,感谢创建 public 存储库的想法,一些人在他们的网站上共享了 Paw collections,但它会很好!)