Giter VIP home page Giter VIP logo

graphql-openapi-spec's Introduction

graphql-openapi-spec

This project aims to contain a generic OpenAPI specification for GraphQL APIs, potentially multiple versions of it.

This specification is not required to use GraphQL APIs. GraphQL does a great job of providing its own schema specification and documentation itself, through a concept called "introspection". When and why do we need an OpenAPI specification, then? There are multiple reasons for this.

  1. Established legacy processes. We sometimes face manual and/or automated governance processes left over from a distant past. These may require developers to supply Swagger or OpenAPI specifications before they can expose their APIs.
  2. Describing GraphQL. People often assume scary things about GraphQL before they learn about it, including that it is more different than it is. They sometimes fear that their clients will have hard time accessing GraphQL but are perfectly comfortable with APIs that can be specified via OpenAPI specs. This specification here can be used to show them, in a language they understand, that GraphQL is friendly and may just be very similar to what they were thinking of themselves

At this point this is not yet a reviewed, tested specification and should only be used as an illustration. Help is welcome.

graphql-openapi-spec's People

Contributors

aleksandarsusnjar avatar

Stargazers

Adam Setch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.