如何在 Postman 中发表评论

Posted 2023-03-08

【中文标题】如何在 Postman 中发表评论

【英文标题】：How to place comments in Postman

【发布时间】：2017-12-06 10:29:01

【问题描述】：

如何在 Postman 中放置 cmets，请求正文部分？或者还有其他地方可以评论邮递员的请求吗？

【问题讨论】：

嗨，你可以看看这个链接：***.com/questions/244777/…

这能回答你的问题吗？ Can comments be used in JSON?

Postman 中的那具尸体并没有什么神奇之处。它只是普通的 JSON。所以不幸的是——正如对Can comments be used in JSON? 的公认答案所述——答案是否。一种可能的解决方法是在您的 JSON 数据中添加一个“假”字段，例如 "_comment": "comment text goes here...",。 - 当然，注释您的一些 JSON 数据的技巧是简单地更改您想要“禁用”的键的名称。

【参考方案1】：

您可以为请求、集合或文件夹编写文档和 cmets using the description section。

【讨论】：

我只想禁用一些不想添加 cmets 或描述的代码。我该怎么做？

与@MahenderReddyYasa 相同的问题

您可以使用 // <single line of code> 或 /** <multiple lines of code */ 模式禁用代码，就像对任何用 javascript 编写的代码所做的那样。

OP 询问如何阻止 Postman 在请求中包含注释代码，这就是问题所在。

【参考方案2】：

我在 GitHub 上查看了 Postman 跟踪他们的功能请求和错误的地方，链接在这里：GitHub issue

您可以在那里添加 cmets，以便在下一个版本中考虑此功能。另外我发现你可以复制粘贴<!-- comment-->来发表评论。

【参考方案3】：

编辑：对不起，不是实际问题的答案。但是，我已经解决了下面的I just want to disable some code not want to add comments or descriptions..how can I do that? – Mahender Reddy Yasa 评论。

在最新的邮递员 7.7.3 64 位版本的 windows 中，我现在可以忽略评论验证和发送请求。

【讨论】：

侧面显示明显错误。请确认。

@Shawn 是的，忽略验证和发送请求将起作用。在上述情况下，Description 不会发送到服务器。

在这里与“//”一起工作

【参考方案4】：

评论选项/按钮在每个请求的发送按钮上方。 但是，我们仍然无法在请求正文中添加评论，也许将来他们会提供此功能

【参考方案5】：

请求属性说明： 数据编辑器中的描述列使您的请求更易于理解。您可以在 Postman 应用程序中为每个查询参数、路径变量、标题和正文（表单数据和 urlencoded）添加 cmets 和详细信息。

在 Postman 中设置评论的另一种方式 发送按钮上有评论选项/按钮。

您可以复制粘贴：< !--comment-->

【讨论】：

能否附上一个带有 POSTMAN 截图的示例？

【参考方案6】：

由Script完成https://community.postman.com/t/request-body-should-be-able-to-be-commented/8288

预请求脚本创建一个对象并将其转换为字符串然后公开它

object = 
   // product: “displayName”,
   price : “15.5”

pm.environment.set(“object”, JSON.stringify(object));

请求正文调用变量object

object

【参考方案7】：

最后，从 Postman v8.3.0 开始，您可以在您的集合中执行此操作 pre-request 脚本：

// Strip JSON Comments
if (pm?.request?.body?.options?.raw?.language === 'json') 
    const rawData = pm.request.body.toString();
    const strippedData = rawData.replace(
        /\\"|"(?:\\"|[^"])*"|(\/\/.*|\/\*[\s\S]*?\*\/)/g,
        (m, g) => g ? "" : m
    );
    pm.request.body.update(JSON.stringify(JSON.parse(strippedData)));

这会从 json 中剥离所有 cmets 并将当前主体设置为已清理的主体，在此代码所基于的 original github post 中有更多其他主体类型（GraphQL、URL 编码、表单数据）的示例。

【参考方案8】：

在 Postman v9.13.0 中，您可以使用 block cmets 来实现