使用GitHub API将markdown表作为Pull Request注释发布到GitHub

时间:2018-10-24 22:12:48

标签: github markdown

我能够使用API​​将文本发布到GitHub上的拉取请求中

https://api.github.com/repos/aftab-hassan/pagerankassignment/pulls/2/comments

并使用以下内容作为正文

{
  "body": "Nice change",
  "commit_id": "5dfc67045edc45ed102f6bf6ad0c1209fdd2ef38",
  "path": "README",
  "position": 4
}

我试图将诸如下面的降价表作为正文而不是上面的纯文本发布。

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

但是,它给我以下错误

{
    "message": "Problems parsing JSON",
    "documentation_url": "https://developer.github.com/v3/pulls/comments/#create-a-comment"
}

我确实尝试将主体类型更改为文本而不是json。 我还尝试将\n添加到降价主体,因为它跨越多行。但是,这些尝试似乎都无效,并且给了我与上述相同的错误。

{
  "body": "First Header | Second Header\n
------------ | -------------\n
Content from cell 1 | Content from cell 2\n
Content in the first column | Content in the second column",
  "commit_id": "5dfc67045edc45ed102f6bf6ad0c1209fdd2ef38",
  "path": "README",
  "position": 4
}

如何通过Postman在Markdown上发布markdown表作为对pull请求的注释?

1 个答案:

答案 0 :(得分:0)

您的JSON字符串应仅包含转义的换行符,而不应包含文字换行符。所以body变成

"First Header | Second Header\n------------ | -------------\nContent from cell 1 | Content from cell 2\nContent in the first column | Content in the second column"

看看this answer,这是一种处理JSON中任意输入的更灵活的方法。