openapi-to-graphql

Translate APIs described by OpenAPI Specifications (OAS) into GraphQL

MIT License

Downloads
156.8K
Stars
1.6K
Committers
37

Bot releases are hidden (Show)

openapi-to-graphql - OpenAPI-to-GraphQL v1.6.1

Published by Alan-Cha about 5 years ago

  • Do not throw errors when dealing with anyOf, oneOf, and not in JSON schema
    • We still do not handle these features. They are a work in progress.
  • Do not add extraneous descriptions to the GraphQL interface
  • Code improvements

Special thanks to @wtrocki for contributing to this release!

openapi-to-graphql - OpenAPI-to-GraphQL v1.6.0

Published by Alan-Cha about 5 years ago

  • Improved support for allOf in JSON schemas

Special thanks to @prevuelta for contributing to this update!

openapi-to-graphql - OpenAPI-to-GraphQL v1.5.0

Published by Alan-Cha about 5 years ago

  • Added new options to the CLI
  • Bug fixes and general improvements

Special thanks to @folding and @moyara for contributing to this update!

openapi-to-graphql - OpenAPI-to-GraphQL v1.4.1

Published by Alan-Cha about 5 years ago

  • Fixed bug where input object types were not properly created for object schemas that did not have properties.
openapi-to-graphql - OpenAPI-to-GraphQL v1.4.0

Published by Alan-Cha about 5 years ago

  • Support for GraphQL ID scalars
    • If a string is of format UUID, it will be mapped to a GraphQL ID
  • Added the idFormats option
    • Allows for greater flexibility over GraphQL ID scalars

Special thanks to @omarchehab98 for contributing to this update!

openapi-to-graphql - OpenAPI-to-GraphQL v1.3.0

Published by Alan-Cha about 5 years ago

  • Objects with no properties fields are stored in an arbitrary JSON type
    • GraphQL object types are very strict but OAS does not enforce that object schemas must have properties fields. We support these objects by using GraphQL JSON type.
  • General code improvements
openapi-to-graphql - OpenAPI-to-GraphQL v1.2.0

Published by Alan-Cha over 5 years ago

openapi-to-graphql - OpenAPI-to-GraphQL v1.1.0

Published by Alan-Cha over 5 years ago

  • Support content property in parameter objects
  • Stringify objects with no properties fields
    • GraphQL object types are very strict but OAS does not enforce that object schemas must have properties fields. For better compatibility, we recursively stringify objects with no properties, which should greatly increase compatibility with in-the-wild OASs.
openapi-to-graphql - OpenAPI-to-GraphQL v1.0.1

Published by Alan-Cha over 5 years ago

  • Fix bug with creating field names for objects

Special thanks to @JennieJi for contributing to this update!

openapi-to-graphql - OpenAPI-to-GraphQL v1.0.0

Published by ErikWittern over 5 years ago

Renamed OASGraph to OpenAPI-to-GraphQL

  • Multi-OAS support
    • Create GraphQL interfaces using multiple APIs
  • Inter-OAS links
    • Allows you to create nested objects the resolve on different APIs
  • Custom resolvers
    • Allows complete control over the generated resolvers. Opens many new doors such as creating resolvers that do not depend on a REST API backend or implementing caching.
  • Add addLimitArgument option
    • Allows to constrain the size of returned lists
  • Added cookie authentication
    • We now have full API key location support (i.e. "query", "header", and "cookie")!
  • Exposed Request options, allowing fine control over generated resolvers
  • Error extensions
    • Errors during query execution are now clearly displayed
  • Collapse links so that GraphQL object types can use links defined in different OAS operations objects
  • Use Prettier for consistent formatting
  • Simplified code base
  • Improved warning handling

Regarding CLI-specific improvements:

  • CORS support

Special thanks to @thejibz, @jamesduf, @jduffy3, @SrChip15 for contributing to this update!

openapi-to-graphql - Renaming OASGraph

Published by ErikWittern over 5 years ago

We renamed OASGraph to OpenAPI-to-GraphQL. This path updates the README to reflect this change. OASGraph is deprecated, but development will continue on OpenAPI-to-GraphQL.

openapi-to-graphql - OpenAPI-to-GraphQL v0.15.0

Published by Alan-Cha over 5 years ago

OpenAPI-to-GraphQL v0.15.0

  • Multi-OAS support
    • Create GraphQL interfaces using multiple APIs
  • Inter-OAS links
    • Allows you to create nested objects the resolve on different APIs
  • Custom resolvers
    • Allows complete control over the generated resolvers. Opens many new doors such as creating resolvers that do not depend on a REST API backend or implementing caching.
  • Added cookie authentication
    • We now have full API key location support (i.e. "query", "header", and "cookie")!
  • Exposed Request options, allowing fine control over generated resolvers
  • Error extensions
    • Errors during query execution are now clearly displayed
  • Collapse links so that GraphQL object types can use links defined in different OAS operations objects
  • Use Prettier for consistent formatting
  • Simplified code base

Regarding CLI-specific improvements:

  • CORS support

Special thanks to @thejibz, @jamesduf, @jduffy3, @SrChip15 for contributing to this update!

openapi-to-graphql - Release notes

Published by Alan-Cha over 5 years ago

OASGraph v0.14.1

  • Added Typescript declaration files

Special thanks to @treffynnon for contributing to this update!

openapi-to-graphql - Release notes

Published by Alan-Cha over 5 years ago

OASGraph v0.14.0

  • Added the operationIdFieldNames option
    • Normally, query field names (as opposed to mutation field names) will be derived from the return type type name. This option will create query field names based off of the operationId, like how mutation field names are normally processed.
openapi-to-graphql - Release notes

Published by Alan-Cha over 5 years ago

OASGraph v0.13.0

  • Added method and path to link descriptions
    • Now you can see which fields are created from links and what REST calls they correspond to
  • Added support for constant and variable link parameters
    • Previously, OASGraph could only support link parameters where the value is unmodified. However, link parameters can also be constants or concatenated with constants. Now we have support for all of these cases.
  • Added full link support
  • Added baseUrl option
    • Allows you to manually input a base URL on which all paths will be built on
    • Useful for testing and development, where the base URL may be changing and/or may not be finalized
  • Capitalize (input) object types
    • It is a common GraphQL convention that (input) object types should be capitalized. We now do so.
  • Sort operations and fields by name

CLI v0.3.0

  • Added YAML support
  • Added CORS option
  • Added baseUrl option
    • See above

Special thanks to @Tonours and @thejibz for contributing to this update!

openapi-to-graphql - Added new tutorials and features

Published by Alan-Cha about 6 years ago

  • Added new tutorials
  • Added new features to the CLI tool (port selection, web-hosted OAS, and output schema)
  • Updated test command, npm test, to start the example APIs used for testing
  • Added Travis CI
openapi-to-graphql -

Published by Alan-Cha about 6 years ago

  • Added a very simple CLI tool that will read an OAS, create a GraphQL interface, and deploy a server.
  • Added a quick start guide with a linked video that describes how the CLI tool is used.
  • Added support for header and cookie parameters. Now fully supports all parameter locations as listed in the OAS.