首页
/ 推荐开源项目:Graffiti.js - 简约的GraphQL框架

推荐开源项目:Graffiti.js - 简约的GraphQL框架

2024-05-21 05:22:25作者:郜逊炳

Graffiti Logo

Graffiti.js 是一个轻量级的GraphQL框架,它的设计目标是让构建GraphQL API变得简单而直观,借助文件系统作为主要API接口,每个.js文件都能转化为一份模式定义,自动处理并转换为GraphQL服务。

安装与使用

要开始使用Graffiti.js,首先通过npm安装:

$ npm install graffiti --save

然后,只需在项目中创建如./schema/note.js./schema/collection.js这样的文件,并导出Mongoose.js的模式定义。例如:

// ./schema/note.js
exports.schema = {
  name: String,
  body: String,
  group: { type: 'ObjectId', ref: 'Collection' }, // 自动处理关联关系
};

// ./schema/collection.js
exports.schema = {
  name: String,
};

执行graffiti dev,即可在http://localhost:3000/playground访问到GraphQL playground进行测试。

功能特性

Graffiti.js 提供了以下核心功能:

  • 自动创建GraphQL API
  • 自动类型之间的关系映射(针对ObjectId
  • 内置GraphQL playground(仅开发模式)
  • 添加自定义解析器或GraphQL方法的支持
  • 手动配置复杂关系的能力
  • 热重载(开发模式下)
  • 支持第三方插件扩展

系统需求

为了运行Graffiti.js,你需要:

  • MongoDB v4.0+ (可以使用Docker快速启动:docker run --name mongodb -p 27017:27017 -d mongo)
  • Node.js v14.8+

工作原理

Graffiti.js基于fastifygraphql-composeMongoose构建。其灵感来源于出色的Next.js,主要目的是减少开发者编写重复代码的工作量。

详细文档可以在./docs目录中找到,更多示例可在./examples目录查看。

致谢

特别感谢:

总的来说,Graffiti.js是一个简洁高效的工具,它帮助开发者以最小的配置开销来构建高效且易于维护的GraphQL服务。如果你正在寻找简化GraphQL开发的方法,那么Graffiti.js绝对值得尝试!

登录后查看全文
热门项目推荐