跳到主要内容

fastify 工具链

@fastify/cors​

安装​
pnpm add @fastify/cors
基础​
  • 解决跨域问题；
import Fastify from "fastify";
import cors from "@fastify/cors";

const fastify = Fastify();
await fastify.register(cors, {
  // put your options here
});

@fastify/formbody​

安装​
pnpm add @fastify/formbody
基础​
  • 解析 application/x-www-form-urlencoded；
import Fastify from "fastify";
import formbody from "@fastify/formbody";

const fastify = Fastify();
await fastify.register(formbody, {
  // put your options here
});

@fastify/helmet​

安装​
pnpm add @fastify/helmet
基础​
  • 安全相关 header；
import Fastify from "fastify";
import helmet from "@fastify/helmet";

const fastify = Fastify();
await fastify.register(helmet, {
  // put your options here
});

@fastify/multipart​

安装​
pnpm add @fastify/multipart
基础​
  • multipart content-type 支持；
import Fastify from "fastify";
import multipart from "@fastify/multipart";

const fastify = Fastify();
await fastify.register(multipart, {
  // put your options here
});

fastify.post("/", async function (req, reply) {
  // process a single file
  // also, consider that if you allow to upload multiple files
  // you must consume all files otherwise the promise will never fulfill
  const data = await req.file();
  data.file; // stream
  data.fields; // other parsed parts
  data.fieldname;
  data.filename;
  data.encoding;
  data.mimetype;
});
大小限制​
  • 默认限制大小为 1 MB；
// 全局设置
fastify.register(require("@fastify/multipart"), {
  limits: {
    fieldNameSize: 100, // Max field name size in bytes
    fieldSize: 100, // Max field value size in bytes
    fields: 10, // Max number of non-file fields
    fileSize: 1000000, // For multipart forms, the max file size in bytes
    files: 1, // Max number of file fields
    headerPairs: 2000, // Max number of header key=>value pairs
    parts: 1000, // For multipart forms, the max number of parts (fields + files)
  },
});

// 局部设置
const options = { limits: { fileSize: 1073741824 } };
const file = await req.file(options);

@fastify/swagger​

安装​

pnpm add --save-dev @fastify/swagger
pnpm add --save-dev @fastify/swagger-ui

基础​

  • 基于 schema 生成 openapi 文档；
  • 注册插件必须使用 await；
import Fastify from "fastify";

const app = Fastify();
await app.register(import("@fastify/swagger"), {
  openapi: {
    openapi: "3.0.3",
    info: {
      title: "openapi",
      version: "0.1.0",
    },
  },
});
await app.register(import("@fastify/swagger-ui"), {
  routePrefix: "/api-doc",
});

定义 schema​

const schema = {
  tags: ["test"],
  body: bodyJsonSchema,
  querystring: queryStringJsonSchema,
  params: paramsJsonSchema,
  headers: headersJsonSchema,
  response: {
    default: responseSchema0,
    200: responseSchema1,
  },
};

fastify.post("/the/url", { schema }, handler);

返回非 json 类型​

  • 仅用于 openapi 3.0；
{
  response: {
    200: {
      description: 'Description and all status-code based properties are working',
      content: {
        'image/png': {
          schema: {}
        }
      }
    }
  }
}