检索自述文件的 HTML

Question

嗨，第一次像这样与 API 一起工作。无论如何，我一直在阅读 GitHub API 并且遇到了这个：

READMEs support custom media types for retrieving the raw content or rendered HTML.

来源：https://developer.github.com/v3/repos/contents/#get-the-readme

我认为这意味着可以检索 README 内容的 HTML 格式版本？如果是这样，我将如何使用 AJAX 检索它，因为教程都是针对 curl 的。最后我想在我的网站上显示它的一部分，如果以 html 格式而不是降价格式给出会容易得多。

文档说了一些关于：application/vnd.github.VERSION.html

就是不知道怎么用

谢谢！

Answer 1

您必须将 HTTP 请求的 Accept header 设置为 application/vnd.github.html。

$.ajax({
  url: 'https://api.github.com/repos/just95/toml.dart/readme',
  headers: { 'Accept': 'application/vnd.github.html' }
}).done(function(data) {
  alert(data);
});

<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

Answer 2

您需要做的就是设置 HTTPS 请求的 Accept header。例如使用 cURL：

curl -i -H "Accept: application/vnd.github.v3.html" https://api.github.com/repos/github/developer.github.com/readme

在JavaScript,

var apiRoot = 'https://api.github.com';
var myUser = YOUR_USER_HERE;
var myRepo = YOUR_REPO_HERE;
var request = new XMLHttpRequest();
request.open('GET', apiRoot + '/repos/' + myUser + '/' + myRepo + '/readme');
request.setRequestHeader('Accept','application/vnd.github.v3.html');
/* add event listeners... */
request.onreadystatechange = function() {
  if (request.readyState === 4 && request.status === 200) {
    document.body.innerHTML = request.response;
  }
};
request.send();

检索自述文件的 HTML

Retrieve HTML of ReadMe

javascript

ajax

github-api