介绍
smartapi-oasgraph-cli 是一个用于将 OpenAPI 规范的 API 转换成 GraphQL 服务的命令行工具。它可以快速地为您生成 GraphQL schema，以便您可以直接开始与您的 RESTful API 进行交互。
在本篇文章中，我们将介绍如何使用 smartapi-oasgraph-cli 转换您的 API，并将其作为 GraphQL schema 转换后的结果进行使用。
安装
smartapi-oasgraph-cli 可以通过 npm 来进行安装。安装命令如下：
npm install smartapi-oasgraph-cli -g
使用
使用 smartapi-oasgraph-cli 有几个必填和可选的参数列表。我们来看看它们。
必填参数
--spec <specification-path>：指定您的 OpenAPI 规范路径。
可选参数
--output <output-path>：指定输出 schema 的路径。默认为./schema.graphql。--headers <headers>：使用 json 字符串指定请求 headers。--depth-limit <depth-limit>：定义生成的 GraphQL schema 的深度。--flat：将请求参数拆分为扁平参数。--no-sort：不按字母顺序排序生成的 GraphQL 类型。--fill-empty-strings：将空字符串作为 null 进行处理。--debug：输出更多调试信息。
示例
下面就让我们来一个示例，以便让您更好地了解如何使用 smartapi-oasgraph-cli。
假如您有一个给定规范的库存 API，路径为：/spec/inventory.v1.yaml。您可以在命令行工具中运行以下命令来将其转化为 GraphQL schema。
smartapi-oasgraph-cli --spec /spec/inventory.v1.yaml
在这个例子中我们没有使用任何的可选参数，所以输出将保存在默认的路径中，即./schema.graphql。
如果有必要，您可以使用--output参数指定输出的文件名称。
smartapi-oasgraph-cli --spec /spec/inventory.v1.yaml --output inventory-schema.graphql
您也可以通过使用--headers参数指定 RESTful API 调用时的 headers 。
smartapi-oasgraph-cli --spec /spec/inventory.v1.yaml --headers '{"Authorization": "Bearer YOUR_ACCESS_TOKEN"}'环境变量也可以通过一个 JSON 文件的方式传递进去。这个 JSON 文件可以通过 --env 参数来指定。
smartapi-oasgraph-cli --spec /spec/inventory.v1.yaml --env env.json
结论
smartapi-oasgraph-cli 是一个轻量级的命令行工具，可以快速地将 OpenAPI 规范转换为 GraphQL schema, 它可以使您更快速地使用您的 RESTful API。我们在这篇文章中介绍了如何使用 smartapi-oasgraph-cli 来转换您的 API。希望这篇文章对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672613660cf7123b3646b