npmpackage.info

openapi-to-graphql

Translate APIs described by OpenAPI Specifications (OAS) into GraphQL

3.0.7

1,612

MIT

TypeScript

5,982,069 4.3

Installations

npm install openapi-to-graphql

Pull Requests

Open

21

Total

231

Closed

51

Merged

159

Issues

Open

120

Total

268

Closed

148

Releases

OpenAPI-to-GraphQL v2.6.3

v2.6.3

Published on 04 Feb 2022

OpenAPI-to-GraphQL v2.6.2

v2.6.2

Published on 03 Feb 2022

OpenAPI-to-GraphQL v2.6.1

v2.6.1

Published on 18 Jan 2022

OpenAPI-to-GraphQL v2.6.0

v2.6.0

Published on 15 Dec 2021

OpenAPI-to-GraphQL v2.5.2

v2.5.2

Published on 28 Nov 2021

OpenAPI-to-GraphQL v2.5.1

v2.5.1

Published on 31 Jul 2021

View all 37 releases

Developer

ibm

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

>=14

Typescript Support

No

Node Version

20.8.1

NPM Version

10.1.0 Statistics

1,612 Stars

685 Commits

211 Forks

39 Watching

2 Branches

45 Contributors

Updated on 25 Nov 2024

Languages

TypeScript (89.29%)

JavaScript (10.71%)

Total Downloads

Cumulative downloads

Total Downloads

5,982,069

Last day

-0.2%

6,603

Compared to previous day

Last week

11.7%

32,249

Compared to previous week

Last month

-4.5%

125,617

Compared to previous month

Last year

2.3%

1,465,550

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Development on OpenAPI-to-GraphQL has paused. GraphQL Mesh is maintaining an OpenAPI/Swagger handler, which is fork of OpenAPI-to-GraphQL. Please find them here.

GitHub last commit

OpenAPI-to-GraphQL

Translate APIs described by OpenAPI Specifications (OAS) or Swagger into GraphQL.

Getting started

OpenAPI-to-GraphQL can be used in two ways:

CLI

The Command Line Interface (CLI) provides a convenient way to start a GraphQL server wrapping an API for a given OpenAPI Specification:

Install the OpenAPI-to-GraphQL CLI using:
```
1npm i -g openapi-to-graphql-cli
```
Then, run the OpenAPI-to-GraphQL command and point it to an OpenAPI Specification:
```
1openapi-to-graphql <OAS JSON file path or remote url> [options]
```

For further details, refer to the openapi-to-graphql-cli documentation.

Library

Use OpenAPI-to-GraphQL as a library in your application to generate GraphQL schemas.

Install OpenAPI-to-GraphQL as a dependency:
```
1npm i -s openapi-to-graphql
```

Require OpenAPI-to-GraphQL and use the createGraphQLSchema function:

1const { createGraphQLSchema } = require("openapi-to-graphql");
2// load or construct OAS (const oas = ...)
3const { schema, report } = await createGraphQLSchema(oas);

For further details, refer to the openapi-to-graphql documentation.

Tutorials

Here are some guides to further help you get started:

CLI + Loopback tutorial: Learn how to quickly spin up GraphQL wrappers using the OpenAPI-to-GraphQL CLI.
Library tutorial: Learn how to use OpenAPI-to-GraphQL as a library, and how to improve the resulting GraphQL wrappers using OAS link definitions.
LoopBack tutorial: Learn how to use OpenAPI-to-GraphQL to create GraphQL wrappers for APIs created with LoopBack 4.
Subscriptions tutorial: Learn how to create a GraphQL API that supports subscription operations - including how to set up the API server that creates a PubSub instance wrapping a MQTT client.

Characteristics

Data-centric The GraphQL interface is created around the data definitions in the given OAS, not around the endpoints, leading to a natural use of GraphQL.
Nested data Links defined in the OAS are used to create nested data structures, allowing for (deeply) nested queries.
Automatic query resolution Automatically generated resolvers translate (nested) GraphQL queries to API requests. Request results are translated back to GraphQL responses.
Mutations Non-safe, non-idempotent API operations (e.g., POST, PUT, DELETE) are translated to GraphQL mutations. Input payload is type-checked.
Subscriptions GraphQL subscriptions allow clients to receive a stream of events, such as updates whenever data changes on the GraphQL server. OpenAPI-to-GraphQL can create subscriptions based on callback objects defined in the OAS.
Authentication OpenAPI-to-GraphQL currently supports authentication via API Key and basic auth. OpenAPI-to-GraphQL wraps secured endpoints into a viewer, which takes the API key / credentials as input.
API Sanitation Parts of an API that not compatible with GraphQL are automatically sanitized. For example, API parameters and data definition names with unsupported characters (e.g., -, ., ,, :, ;...) are removed. GraphQL queries are desanitized to correctly invoke the REST API and the responses are resanitized to create GraphQL-compliant results.
Custom request options Provide headers and query parameters to send with every API request. This allows, for example, to handle authentication or tag requests from GraphQL.
Swagger and OpenAPI 3 support OpenAPI-to-GraphQL can handle both Swagger (OpenAPI specification 2.0) as well as OpenAPI specification 3.

Development

OpenAPI-to-GraphQL is written in TypeScript. Within each of OpenAPI-to-GraphQL's packages, all source code is contained in the src folder. Use yarn build or yarn test to transpile the source files into the final library in the dist folder. Entry-point for the library is index.js in dist.

Research

Our research paper, "Generating GraphQL-Wrappers for REST(-like) APIs", can be found here. The paper describes the challenges of building OpenAPI-to-GraphQL and an experiment in which we evaluated OpenAPI-to-GraphQL against 959 publicly available OAS, provided by APIs.guru, and successfully created GraphQL interfaces for 89.5% of them.

To run the experiment, in the openapi-to-graphql package, load APIs.guru specifications, found here, into the /tmp folder:

1npm run guru-load

Then, run tests:

1npm run guru-test <number of APIs to test at most>

Similar projects

swagger-to-graphql turns a given Swagger (OpenAPI Specification 2.0) into a GraphQL interface, which resolves against the original API. GraphQL schema is based on endpoints, not on data definitions. No links are considered.
json-to-graphql turns given JSON objects / arrays into a GraphQL schema. resolve functions need to be provided by the user.
StackOverflow discussion points to the above projects.

License

MIT

No vulnerabilities found.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

7

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

3

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

3

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

Score

4.3

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to openapi-to-graphql

openapi-to-graphql-cli

3.0.7

CLI for turning APIs described by OpenAPI Specifications (OAS) into GraphQL interfaces

openapi-to-graphql-nullable

3.0.4

Fork of openapi-to-graphql that fixes nullable handling. Published to NPM since there's no other easy way to consume a Lerna package. Unmaintained.

openapi-typescript

7.4.3

Convert OpenAPI 3.0 & 3.1 schemas to TypeScript

graphql

16.9.0

A Query Language and Runtime which can target any service.

openapi-to-graphql

Installations

Pull Requests

21

231

51

159

Issues

120

268

148

Releases

Developer

Developer Guide

CommonJS, ESM

>=14

No

20.8.1

10.1.0

Statistics

Languages

Total Downloads

5,982,069

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Development on OpenAPI-to-GraphQL has paused. GraphQL Mesh is maintaining an OpenAPI/Swagger handler, which is fork of OpenAPI-to-GraphQL. Please find them here.

OpenAPI-to-GraphQL

Getting started

CLI

Library

Tutorials

Characteristics

Development

Research

Similar projects

License

10

10

10

10

7

3

3

0

0

0

0

0

0

4.3

/10

Other packages similar to openapi-to-graphql