典当文件库

Question

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

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

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

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

Answer 1

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

My-Blog-API.爪

• 用户（一个组）
  • 获取一个用户（Get/users/：id）
  • 创建用户（POST/users）
• 文章（一组）
  • 获取文章列表（Get/articles）
  • 获取一篇文章（Get/articles/：id）
  • 创建文章（POST/articles）

通过这种方式，您的文档密切遵循API的语义。此外，它还允许对环境进行良好的组织，例如存储API的基本URL或用户凭据/访问令牌。

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

• Related（a group）
  • Twitter（一个群组）
    • 使用Twitter登录（获取https://api.twitter.com/login–无论我不知道确切的URL）

（此外，感谢创建公共回购的想法，一些人在他们的网站上共享了Paw集合，但这会很好！）