graphql-mesh icon indicating copy to clipboard operation
graphql-mesh copied to clipboard

Documentation revamp πŸ“– ✨ (umbrella issue)

Open charlypoly opened this issue 2 years ago β€’ 1 comments

  • [x] Index page (Project purpose and vision /w illustrations, Performances expectations)
  • Getting Started
    • [x] Overview (Concepts, Glossary)
    • [x] Installation
    • [x] Our first Mesh Gateway (simple tutorial: one source, simple transforms + next steps overview β†’ guides)
    • [x] Combine multiple Sources
    • [x] Handle Sources with no definition (additional resolvers/typeDefs vs jsonSchema handler with samples)
    • [x] Customize the Mesh server (Envelop, cache, included server vs a custom server)
    • [x] Deploy a GraphQL Mesh gateway (Serverless, Mesh artifacts, docker, etc...)
    • [x] Comparison table β†’ β€œBuilding Unified Schema Gateway experience”

#3731, #3779


  • Guides
    • [x] Extending the Unified Schema (additionalResolvers guide)
    • [x] Configure GraphQL Code Generator with Mesh (configuration, resolvers type safety)
    • [x] Performances best practices (batching, etc)
    • [x] Advanced Transforms: root-level, source-level and order
    • [x] Error handling
    • [x] File upload
    • [x] Live Queries
    • [x] Subscriptions & Webhooks

#3824


  • Handlers reference
  • Transforms reference
    • [x] β†’ review and update
    • [x] update JSON Schema handler documentation (@TuvalSimha, @charlypoly)

βš οΈΒ β†’ API reference on a dedicated page + top nav link (different from documentation)

β†’ should we drop the API reference?

charlypoly avatar Mar 29 '22 09:03 charlypoly

Examples revamp:

Services

Books API (OpenAPI)

  • GET /books
  • GET /books/:id
  • GET /books/categories

Authors API (gRPC)

  • list
  • one

Stores (GraphQL)

  • stores Query
  • bookSells Query

Mesh use-cases

Getting started > Build your first Gateway

  • Books APIs -> list -> books Query

How to > Combine multiple Sources

Target Query:

query bestSellersByStore {
  stores {
    location
    name
    booksells {
      name
      categories {
        name
      }
      authors {
        name
      }
    }
  }
}

Guides > Performances

Use batching and query batching for:

query bestSellersByStore {
  stores {
    location
    name
    booksells {
      name
      categories {
        name
      }
      authors {
        name
      }
    }
  }
}

Guides > Extending the Unified Schema

Target Query:

query bestSellersByStore {
  bestSellers { # across stores
    name
    categories {
      name
    }
    authors {
      name
    }
  }
}

charlypoly avatar Mar 30 '22 10:03 charlypoly