guide导出为 PDF 本地 REST API 使用

导出为 PDF 本地转换器提供了通过 RESTful API 将 HTML 文档转换为 PDF 文件的功能。

API 可在 https://127.0.0.1:[port] 上访问(默认情况下,port8080)。

REST API 文档可在 https://127.0.0.1:[port]/docs 上找到。
或者,您可以在我们的公共资源 https://pdf-converter.cke-cs.com/docs 中查看规范。

如果您已获得 API 的授权,则应提供授权令牌。更多说明请参见 授权 部分。

# 使用额外的 HTTP 头部

如果获取生成的 PDF 中使用的某些资源(例如图片)需要以额外的 HTTP 头部的形式传递额外的授权因子

  1. 它可以通过在应用程序启动时设置 EXTRA_HTTP_HEADERS 环境变量来定义,该变量的值是包含所需头部的字符串化的 JSON 对象。
  2. 它可以在发送到 PDF 转换器 API 的请求中的 options 中定义。
const data = {
   html: '<p>I am a teapot</p><img src="https://secured-example-website.com/image.jpg">',
   css: 'p { color: red; }',
   options: {
      extra_http_headers: {
        authorization: 'Bearer RDp0NqyePooNWFIWvHtbKrKKHLXfmLfZcv3PRpCyJI90uwi3pKvumKl2vymCxoGFw6Vx'
      }
   }
};

axios.post( 'https://pdf-converter.cke-cs.com/v1/convert', data, config )
   .then( response => {
      fs.writeFileSync('./file.pdf', response.data, 'binary')
   } ).catch( error => {
      console.log( error );
   } );

应用程序配置和请求中定义的头文件将合并。如果在两个地方都定义了相同的头文件,则优先使用来自 PDF 选项的头文件值。