Plots2: 用于编写 API 的令牌系统文档

嘿@jywarren我可以工作吗？

肯定的，谢谢！

很抱歉当时没有记录该功能，因为我急于完成时间线上的任务。 感谢您自愿参与其中，@namangupta01！ 我很乐意在您完成记录后对其进行审查。

完全没有问题！ 团队合作！

@ryzokuken谢谢！ :)

@jywarren @ryzokuken所以我正在研究这个问题，我想知道我是否只需要通过令牌记录评论，即https://github.com/publiclab/plots2/pull/1513/files ？

@namangupta01正确！ 这是我实际编写通过令牌进行评论的代码的 PR。

大家好！ 我也可以帮忙吗？ 到目前为止进展如何？ 我正在考虑开始编写令牌文档以更熟悉 API。

@stefannibrasil我认为现在已经放弃了，所以你可以随意继续工作。 如果您遇到任何问题，请告诉我们。

谢谢， @ryzokuken我将在本周开始记录令牌功能。 我会看一些例子，当然，我会让你知道任何事情。 谢谢您的帮助！

@sukhbir-singh 你也想开始研究这个吗？ 我们可以稍后比较我们的工作。

是的！ 当然：微笑：
@stefannibrasil你活跃于 gitter 吗？？

嗨@jywarren和@ryzokuken！ 在阅读了此处提供的更多文档后，我有一些问题要问：

• app/api/src/文件夹中的文件是 Swagger 用来生成Interface的文档，对吗？

• 为了生成令牌认证的文档，我是否需要在上面提到的文件夹中创建一个新文件，显示 CommentController 创建操作的工作原理？

这就是我目前所理解的。 如果您能提供更多相关信息，我将不胜感激。 谢谢！

@stefannibrasil为了节省时间和精力，我避免将“对令牌进行评论”操作作为现有 Swagger API 规范的一部分，并在 Rails 代码库中创建了一个独立函数（在CommentController ，您是对）并为此制定了一条路线。

我不认为 Swagger 允许您记录外部函数，但我可能错了。
所以，我相信你应该自己添加一些文档，以 Markdown 格式以doc/api.md ，解释一下该函数是如何工作的，以及我们希望用户如何使用这个端点添加他们自己的评论。

我希望这说清楚了，请随时要求澄清任何这一点。

有道理，谢谢！ 在查看了更多文档以及如何编写 API 文档后，我对这个PR添加了一些更改。 我不确定这是否是您要求的文件类型。

我在描述中添加了我的问题，请您看一下，看看您是否可以帮助我？

我找不到有关令牌的太多文档，您也可以告诉我在哪里查看更多信息，这会有所帮助！ :)

@sukhbir-singh 抱歉，我不在 gitter 上，但如果你愿意，你也可以在 PR 中做出贡献，那就太好了。

@stefannibrasil您可以查看此视频以获取演示如何使用邮递员向评论 API 发出请求。 ：气球：

太好了，这是完整的，还是我们可以就此展开更多讨论？ 如果完成，请随意关闭它！ 谢谢，所有！！！

实际上，也许我们可以添加一些附加内容——例如，我们是否可以将POST https://publiclab.org/comment/create/token/id.:format细化POST https://publiclab.org/comment/create/token/id.json以显示您可以指定这样的格式。 也许我们应该链接到源代码中令牌 API 代码的位置？

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

@jywarren +1，听起来很完美。

嘿大家！ 这些都是好点，谢谢！ PR 已经合并，我会添加这个并创建另一个然后 =)

另外，感谢@sukhbir-singh 感谢这里的所有帮助！

没问题...！！ 乐于帮助。 我在 github、gitter 和 irc 上非常活跃，如果您在任何情况下需要帮助，都可以进一步联系我。 ：笑脸：