开源项目 nanographql 使用教程

开源项目 nanographql 使用教程

nanographqlTiny graphQL client library项目地址:https://gitcode.com/gh_mirrors/na/nanographql

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

nanographql/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── index.js
├── package.json
└── test.js

• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• LICENSE: 项目许可证，本项目使用 MIT 许可证。
• README.md: 项目说明文档。
• index.js: 项目的主文件，包含主要的 GraphQL 客户端功能。
• package.json: 项目的依赖管理文件，包含项目的元数据和依赖包。
• test.js: 项目的测试文件，用于测试 GraphQL 客户端功能。

2. 项目的启动文件介绍

index.js 是项目的启动文件，主要功能是创建一个 GraphQL 查询对象。以下是文件的主要内容：

var gql = require('nanogql')
var xhr = require('xhr')

var query = gql`
  query($number_of_repos:Int) {
    viewer {
      name
      repositories(last: $number_of_repos) {
        nodes {
          name
        }
      }
    }
  }
`

var variables = { number_of_repos: 3 }

xhr('/query', { json: query(variables) }, function (err, res, body) {
  if (err) throw err
  if (body.errors) throw body.errors
  console.log(body.data)
})

• gql: 用于创建 GraphQL 查询字符串。
• xhr: 用于发送 HTTP 请求。
• query: 定义了一个 GraphQL 查询，获取用户名称和最近的三个仓库名称。
• variables: 查询变量，这里定义了 number_of_repos 为 3。
• xhr 函数用于发送查询请求，并处理响应。

3. 项目的配置文件介绍

package.json 是项目的配置文件，包含了项目的元数据和依赖包。以下是文件的主要内容：

{
  "name": "nanographql",
  "version": "1.0.0",
  "description": "Tiny graphQL client library",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "graphql",
    "client",
    "tiny"
  ],
  "author": "choojs",
  "license": "MIT",
  "dependencies": {
    "xhr": "^2.6.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的主入口文件。
• scripts: 定义了一些脚本命令，如测试命令。
• keywords: 项目的关键词。
• author: 项目作者。
• license: 项目许可证。
• dependencies: 项目的依赖包，这里依赖 xhr 库。

以上是 nanographql 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

nanographqlTiny graphQL client library项目地址:https://gitcode.com/gh_mirrors/na/nanographql