名称: graphql-implementation 描述: 使用Apollo或Graphene构建GraphQL API,包括模式设计、解析器、错误处理和性能优化。适用于创建灵活查询API、从REST迁移或实现实时订阅时。
GraphQL实现
构建GraphQL API,具备适当的模式设计、解析器和性能优化。
模式定义
type User {
id: ID!
name: String!
email: String!
posts(limit: Int = 10): [Post!]!
}
type Post {
id: ID!
title: String!
content: String!
author: User!
createdAt: DateTime!
}
type Query {
user(id: ID!): User
users(limit: Int, offset: Int): [User!]!
post(id: ID!): Post
}
type Mutation {
createUser(input: CreateUserInput!): User!
createPost(input: CreatePostInput!): Post!
}
input CreateUserInput {
name: String!
email: String!
}
Apollo服务器设置
const { ApolloServer } = require('@apollo/server');
const { startStandaloneServer } = require('@apollo/server/standalone');
const resolvers = {
Query: {
user: (_, { id }, { dataSources }) =>
dataSources.userAPI.getUser(id),
users: (_, { limit, offset }, { dataSources }) =>
dataSources.userAPI.getUsers({ limit, offset })
},
User: {
posts: (user, { limit }, { dataSources }) =>
dataSources.postAPI.getPostsByUser(user.id, limit)
},
Mutation: {
createUser: (_, { input }, { dataSources }) =>
dataSources.userAPI.createUser(input)
}
};
const server = new ApolloServer({ typeDefs, resolvers });
DataLoader用于N+1预防
const DataLoader = require('dataloader');
const userLoader = new DataLoader(async (ids) => {
const users = await User.find({ _id: { $in: ids } });
return ids.map(id => users.find(u => u.id === id));
});
错误处理
const { GraphQLError } = require('graphql');
throw new GraphQLError('用户未找到', {
extensions: { code: 'NOT_FOUND', argumentName: 'id' }
});
最佳实践
- 使用DataLoader批量查询
- 实现查询复杂度限制
- 围绕客户端需求设计模式
- 验证所有输入
- 使用描述性命名约定
Python Graphene
参见references/python-graphene.md 获取完整的Flask实现,包括:
- ObjectType定义
- Query和Mutation类
- 输入类型
- Flask集成
最佳实践
应做:
- 使用DataLoader批量查询
- 实现查询复杂度限制
- 围绕客户端需求设计模式
- 验证所有输入
- 使用描述性命名约定
- 添加订阅以支持实时数据
不应做:
- 允许深度嵌套查询而不加限制
- 暴露数据库内部结构
- 忽略N+1查询问题
- 返回未授权数据
- 跳过输入验证