paw-app - 爪子文件存储库？

Question

我仍在为如何使用和组织 Paw 文件（*.paw文档）而苦苦挣扎，尤其是作为 API 使用者。是否更聪明：

1. 按项目组织（即项目 A 使用这些特定的 API 调用，因此my-project.paw为该项目/客户创建一个文档）；或者

2. 按API 服务组织（即MailChimp.paw定义各种 MailChimp 端点的文档，然后为每个使用 MailChimp API 的项目添加新环境）？

（附带说明一下，如果有一个公共存储库来共享流行 API 的 .paw 文件，那就太好了！）

Answer 1

没有规则，您可以根据自己的用例组织内容，但我建议围绕 API 组织文件，因此所有文件都围绕给定 API 排序，遵循其标准，根据 API 提供的资源对请求进行分组。一个树示例是：

我的博客 API.paw

• 用户（一组）
  • 获取一个用户 (GET /users/:id)
  • 创建用户（POST /users）
• 文章（一组）
  • 获取文章列表（GET /articles）
  • 获取一篇文章 (GET /articles/:id)
  • 创建文章（POST /articles）

这样，您的文档就紧跟 API 的语义。此外，它还允许对Environments进行良好的组织，例如存储 API 的 Base URL 或用户凭证/访问令牌。

不过，也许我会保留一个“相关”文件夹，用于调用 API 调用所需的 3rd 方服务。例如，您可能希望调用 Twitter API 以获取访问令牌，然后将其传递给 API 以获取“使用 Twitter 登录”功能。

• 相关（一组）
  • 推特（一组）
    • 使用 Twitter 登录（获取https://api.twitter.com/login - 无论我不知道确切的 URL）

（另外，感谢创建公共回购的想法，有些人在他们的网站上分享了 Paw 收藏，但这会很好！）