📅  最后修改于: 2023-12-03 15:01:03.963000             🧑  作者: Mango
GraphiQL 是一个基于 Web 的交互式 GraphQL IDE。它允许开发人员在浏览器中轻松地探索 GraphQL API、构建查询、调试和测试 GraphQL 服务。GraphiQL 的用户界面非常直观和易于使用,可以让开发人员快速地了解 GraphQL API,有效地提高开发效率。
GraphiQL 是一个开源的项目,你可以到它的 GitHub 仓库中下载最新版本:
git clone git@github.com:graphql/graphiql.git
或者你可以使用 npm 安装 GraphiQL:
npm install --save graphiql
如果你用的是 React,你还可以使用下面的命令安装 React 版本的 GraphiQL:
npm install --save graphiql-react
GraphiQL 可以作为一个独立的应用程序运行,也可以嵌入到其他 Web 应用程序中。如果你想独立运行 GraphiQL,你可以通过下面的命令启动一个本地的 GraphQL 服务:
npm install --save graphql
然后在你的项目中引入 GraphQL,创建 GraphQLSchema,最后启动 GraphQL server。
const express = require('express');
const { graphqlHTTP } = require('express-graphql');
const { buildSchema } = require('graphql');
// 1. 定义 GraphQL schema
const schema = buildSchema(`
type Query {
hello: String
}
`);
// 2. 实现 GraphQL API
const rootValue = {
hello: () => 'Hello, GraphiQL!'
};
// 3. 启动 GraphQL server
const app = express();
app.use('/graphql', graphqlHTTP({
schema: schema,
rootValue: rootValue,
graphiql: true
}));
app.listen(4000);
console.log('Running a GraphQL API server at http://localhost:4000/graphql');
在浏览器中打开 http://localhost:4000/graphql,你就可以看到 GraphiQL 的界面了。
如果你想嵌入 GraphiQL 到你的 Web 应用程序中,你可以使用 graphiql-react 组件。首先,你需要在你的项目中引入 graphiql-react:
npm install --save graphiql-react
然后在你的 React 组件中使用 GraphiQL 组件即可:
import React from 'react';
import ReactDOM from 'react-dom';
import GraphiQL from 'graphiql-react';
function App() {
return (
<GraphiQL
fetcher={params => fetch('/graphql', {
method: 'post',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(params)
}).then(response => response.json())}
/>
);
}
ReactDOM.render(<App />, document.getElementById('root'));
这样,你就可以在你的 Web 应用程序中嵌入 GraphiQL 了。
本文介绍了 GraphiQL 的下载、安装和使用方法。希望本文可以帮助你更好地了解 GraphiQL,并在开发过程中提高开发效率。如果你有任何问题或建议,欢迎在评论区留言。