From 8304ed23ccdfc00132ed6c35579d0b40efbdaf8e Mon Sep 17 00:00:00 2001 From: Jay Herron Date: Sat, 28 Feb 2026 14:15:31 -0700 Subject: [PATCH 1/2] docs: Adds other project links to documentation --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7071aba..ab6e32c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ This is a Swift package plugin that generates server-side GraphQL API code from GraphQL schema files, inspired by [GraphQL Tools' makeExecutableSchema](https://the-guild.dev/graphql/tools/docs/generate-schema) and [Swift's OpenAPI Generator](https://github.com/apple/swift-openapi-generator). +To expose your schema through HTTP, check out [graphql-vapor](https://github.com/GraphQLSwift/graphql-vapor) or [graphql-hummingbird](https://github.com/GraphQLSwift/graphql-hummingbird). To define your schema in native Swift, use [Graphiti](https://github.com/GraphQLSwift/Graphiti) instead. + ## Features - **Data-driven**: Guarantee conformance with the declared GraphQL spec From 7dddbe25c52e5eff51d09afb3917f17bb80e7141 Mon Sep 17 00:00:00 2001 From: Jay Herron Date: Sat, 28 Feb 2026 14:25:43 -0700 Subject: [PATCH 2/2] docs: Consistency with other GraphQLSwift projects --- README.md | 38 +++++++------------------------------- 1 file changed, 7 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ab6e32c..b8e8943 100644 --- a/README.md +++ b/README.md @@ -5,39 +5,15 @@ This is a Swift package plugin that generates server-side GraphQL API code from GraphQL schema files, inspired by [GraphQL Tools' makeExecutableSchema](https://the-guild.dev/graphql/tools/docs/generate-schema) and [Swift's OpenAPI Generator](https://github.com/apple/swift-openapi-generator). -To expose your schema through HTTP, check out [graphql-vapor](https://github.com/GraphQLSwift/graphql-vapor) or [graphql-hummingbird](https://github.com/GraphQLSwift/graphql-hummingbird). To define your schema in native Swift, use [Graphiti](https://github.com/GraphQLSwift/Graphiti) instead. - -## Features - -- **Data-driven**: Guarantee conformance with the declared GraphQL spec -- **Type-safe**: Leverages Swift's type system for compile-time safety -- **Flexible implementation**: Makes no assumptions about backing data types other than GraphQL type conformance -- **Minimal boilerplate**: Generates all the piping between Swift and GraphQL - you just write the resolvers - -## Installation +Using this package has the following benefits: +- Guarantees conformance with the declared GraphQL spec +- Leverages Swift's type system for compile-time safety +- Flexiblity in backing data types +- Generates all the piping between Swift and GraphQL - you just write the resolvers -Add the package to your `Package.swift`. Be sure to add the `GraphQLGeneratorRuntime` dependency to your package, and add the `GraphQLGeneratorPlugin` to the plugins section: - -```swift -dependencies: [ - .package(url: "https://github.com/GraphQLSwift/GraphQL.git", from: "4.1.0"), - .package(url: "https://github.com/GraphQLSwift/graphql-generator", from: "1.0.0") -], -targets: [ - .target( - name: "YourTarget", - dependencies: [ - .product(name: "GraphQL", package: "GraphQL"), - .product(name: "GraphQLGeneratorRuntime", package: "graphql-generator"), - ], - plugins: [ - .plugin(name: "GraphQLGeneratorPlugin", package: "graphql-generator") - ] - ) -] -``` +To expose your schema through HTTP, check out [graphql-vapor](https://github.com/GraphQLSwift/graphql-vapor) or [graphql-hummingbird](https://github.com/GraphQLSwift/graphql-hummingbird). To define your schema in native Swift, use [Graphiti](https://github.com/GraphQLSwift/Graphiti) instead. -## Quick Start +## Usage Take a look at the example projects to see real, fully featured implementations: - [HelloWorldServer](Examples/HelloWorldServer) - Demonstrates all GraphQL type mappings with a comprehensive schema