Sinh SDL (Generating SDL) — Tài liệu NestJS tiếng Việt

Cảnh báo Chương này chỉ áp dụng cho cách tiếp cận code first.

Để sinh thủ công một schema GraphQL SDL (nghĩa là không cần chạy ứng dụng, kết nối database, gắn resolver, v.v.), dùng GraphQLSchemaBuilderModule.

async function generateSchema() {
  const app = await NestFactory.create(GraphQLSchemaBuilderModule);
  await app.init();

  const gqlSchemaFactory = app.get(GraphQLSchemaFactory);
  const schema = await gqlSchemaFactory.create([RecipesResolver]);
  console.log(printSchema(schema));
}

Gợi ý GraphQLSchemaBuilderModule và GraphQLSchemaFactory được import từ package @nestjs/graphql. Hàm printSchema được import từ package graphql.

Cách dùng

Method gqlSchemaFactory.create() nhận một mảng các tham chiếu class resolver. Ví dụ:

const schema = await gqlSchemaFactory.create([
  RecipesResolver,
  AuthorsResolver,
  PostsResolver,
]);

Nó cũng nhận một tham số thứ hai tùy chọn là một mảng các class scalar:

const schema = await gqlSchemaFactory.create(
  [RecipesResolver, AuthorsResolver, PostsResolver],
  [DurationScalar, DateScalar],
);

Cuối cùng, bạn có thể truyền vào một object options:

const schema = await gqlSchemaFactory.create([RecipesResolver], {
  skipCheck: true,
  orphanedTypes: [],
});

skipCheck: bỏ qua việc kiểm tra (validation) schema; kiểu boolean, mặc định false
orphanedTypes: danh sách các class không được tham chiếu tường minh (không phải một phần của object graph) nhưng vẫn muốn được sinh ra. Thông thường, nếu một class được khai báo nhưng không được tham chiếu ở đâu khác trong graph, nó sẽ bị bỏ qua. Giá trị của property này là một mảng các tham chiếu class.

Ghi chú người dịch orphanedTypes giải quyết một tình huống khá thực tế: bạn có một type (ví dụ enum trạng thái, hoặc một interface) không được field nào của resolver trực tiếp trả về, nên khi Nest duyệt graph từ resolver xuống nó sẽ không “nhìn thấy” type đó — giống như tree-shaking loại bỏ code không dùng tới. Nếu vẫn muốn type đó xuất hiện trong schema (ví dụ vì client cần biết shape của nó), bạn phải khai báo tường minh ở đây.