url-to-pdf-api 项目教程

1. 项目的目录结构及介绍

url-to-pdf-api/
├── Dockerfile
├── LICENSE
├── README.md
├── api
│   ├── index.js
│   ├── pdf.js
│   ├── render.js
│   └── utils.js
├── config
│   ├── default.yaml
│   └── production.yaml
├── package.json
└── test
    ├── api.test.js
    └── render.test.js

• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• api: 包含 API 的主要逻辑文件。
  • index.js: API 的入口文件。
  • pdf.js: 处理 PDF 生成的逻辑。
  • render.js: 处理页面渲染的逻辑。
  • utils.js: 包含一些工具函数。
• config: 包含项目的配置文件。
  • default.yaml: 默认配置文件。
  • production.yaml: 生产环境配置文件。
• package.json: 项目的依赖管理文件。
• test: 包含项目的测试文件。
  • api.test.js: API 的测试文件。
  • render.test.js: 渲染逻辑的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 api/index.js。这个文件是整个 API 的入口点，负责启动服务器并处理请求。以下是 api/index.js 的主要内容：

const express = require('express');
const bodyParser = require('body-parser');
const pdf = require('./pdf');
const render = require('./render');
const utils = require('./utils');

const app = express();
app.use(bodyParser.json());

app.post('/api/render', async (req, res) => {
  try {
    const pdfBuffer = await render.renderUrlToPdf(req.body);
    res.setHeader('Content-Type', 'application/pdf');
    res.send(pdfBuffer);
  } catch (error) {
    res.status(500).send(error.message);
  }
});

const port = process.env.PORT || 9000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

• 引入依赖: 引入了 express, body-parser, 以及自定义的 pdf, render, 和 utils 模块。
• 创建 Express 应用: 使用 express() 创建一个应用实例。
• 使用中间件: 使用 bodyParser.json() 解析 JSON 请求体。
• 定义路由: 定义了一个 POST 请求的路由 /api/render，用于处理 PDF 生成请求。
• 启动服务器: 监听指定的端口（默认是 9000），并输出服务器启动的日志。

3. 项目的配置文件介绍

项目的配置文件位于 config 目录下，主要包括 default.yaml 和 production.yaml。

default.yaml

port: 9000
puppeteer:
  args:
    - '--no-sandbox'
    - '--disable-setuid-sandbox'
  headless: true

• port: 指定服务器监听的端口，默认是 9000。
• puppeteer: 配置 Puppeteer 的启动参数和 headless 模式。

production.yaml

port: 8080
puppeteer:
  args:
    - '--no-sandbox'
    - '--disable-setuid-sandbox'
  headless: true

• port: 指定生产环境服务器监听的端口，默认是 8080。
• puppeteer: 配置 Puppeteer 的启动参数和 headless 模式。

这两个配置文件通过环境变量来选择使用哪一个，例如在生产环境中可以通过设置环境变量 NODE_ENV=production 来使用 production.yaml 配置。