# Development on OpenAPI-to-GraphQL has paused. [GraphQL Mesh](https://the-guild.dev/graphql/mesh) is maintaining an [OpenAPI/Swagger handler](https://github.com/ardatan/graphql-mesh/tree/39e8e083cdb5b6e0746a9bdab7cc71555fb40220/packages/loaders/openapi), which is fork of OpenAPI-to-GraphQL. Please find them [here](https://the-guild.dev/graphql/mesh/docs/handlers/openapi).
[](https://www.npmjs.com/package/openapi-to-graphql-cli)
[](https://gitter.im/IBM/openapi-to-graphql?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# OpenAPI-to-GraphQL CLI
Command line interface (CLI) for turning APIs described by [OpenAPI Specification (OAS)](https://github.com/OAI/OpenAPI-Specification) into [GraphQL](https://graphql.org/) interfaces.
_Note: To use OpenAPI-to-GraphQL as a library, refer to the [`openapi-to-graphql`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql) package._
## Installation
```bash
npm i -g openapi-to-graphql-cli
```
## Usage
```
Usage: openapi-to-graphql [options]
Options:
-V, --version output the version number
-s, --strict throw an error if OpenAPI-to-GraphQL cannot run without compensating for errors or missing data in the OAS
--save save schema to path and do not start server
-p, --port select the port where the server will start
-u, --url select the base url which paths will be built on
--cors enable Cross-origin resource sharing (CORS)
-o, --operationIdFieldNames create field names based on the operationId
-f, --fillEmptyResponses create placeholder schemas for operations with no response body rather than ignore them
--addLimitArgument add a limit argument on fields returning lists of objects/lists to control the data size
--genericPayloadArgName Sets argument name for the payload of a mutation to 'requestBody'
--simpleNames Only remove illegal characters from names in the OAS and ignore casing and formatting
--singularNames Experimental feature that will create more meaningful names from the operation path
-H, --header add headers to every request; repeatable flag; set using key:value notation (default: [])
-Q, --queryString add query parameters to every request; repeatable flag; set using key:value notation (default: [])
--no-viewer do not create GraphQL viewer objects for passing authentication credentials
--no-extensions do not add extentions, containing information about failed REST calls, to the GraphQL errors objects
--no-equivalentToMessages do not append information about the underlying REST operations to the description of fields
-h, --help output usage information
```
The basic usage of the CLI takes the specified OAS, creates a GraphQL interface for it, and starts a server to host the GraphQL interface.
```sh
openapi-to-graphql oas.json
```
You can also create a GraphQL interface using multiple OASs.
```sh
openapi-to-graphql oas.json oas2.json oas3.json
```
---
You can specify the OAS by pointing to either a local file or a remote url such as `http://127.0.0.1:3000/openapi.json`. Additionally, you can specify a port number so you can have multiple GraphQL servers running on the same machine.
```sh
openapi-to-graphql http://127.0.0.1:3000/openapi.json -p 3001
```
---
OpenAPI-to-GraphQL can also save a GraphQL schema to a local file, which you can use to inspect or change its content. Please note that the following command will not start the GraphQL server.
```sh
openapi-to-graphql oas.json --save schema.graphql
```
---
You can use multiple `header` and `queryString` to add headers and query strings to the resolvers. Use the syntax: `{key}:{value}`.
```sh
openapi-to-graphql oas.json -H someHeader:someValue -H anotherHeader:anotherValue -Q "exampleQueryString:This one contains spaces!"
```
---
To learn more about the other options, please refer [here](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#options).
Please note that the CLI tool is mainly used for quick testing and does not offer all the features that [`createGraphQLSchema(oas, options)`](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#usage) does.
## License
[MIT](./LICENSE.md)