Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-nexus/nexus
Code-First, Type-Safe, GraphQL Schema Construction
https://github.com/graphql-nexus/nexus
graphql graphql-nexus graphql-schema nexus typescript
Last synced: 12 days ago
JSON representation
Code-First, Type-Safe, GraphQL Schema Construction
- Host: GitHub
- URL: https://github.com/graphql-nexus/nexus
- Owner: graphql-nexus
- License: mit
- Created: 2018-11-02T21:11:33.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-11-19T09:46:52.000Z (12 months ago)
- Last Synced: 2024-09-17T11:28:38.120Z (about 2 months ago)
- Topics: graphql, graphql-nexus, graphql-schema, nexus, typescript
- Language: TypeScript
- Homepage: https://nexusjs.org
- Size: 18.2 MB
- Stars: 3,396
- Watchers: 33
- Forks: 274
- Open Issues: 255
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-graphql - graphql-nexus - Code-First, Type-Safe, GraphQL Schema Construction. (Implementations / JavaScript/TypeScript)
- awesome-list - nexus - First, Type-Safe, GraphQL Schema Construction | graphql-nexus | 2517 | (TypeScript)
README
# Nexus
[](https://github.com/graphql-nexus/nexus/actions/workflows/trunk.yml)
[](https://badge.fury.io/js/nexus)
Declarative, code-first and strongly typed GraphQL schema construction for TypeScript & JavaScript.
## Installation
```
npm install nexus graphql
```
Note you must also add `graphql`. Nexus pins to it as a [peer dependency](https://nodejs.org/en/blog/npm/peer-dependencies/).
## Features
- **Expressive, declarative API for building schemas**
- **Full type-safety for free**
- **Powerful plugin system**
- **No need to re-declare interface fields per-object**
- **Optionally possible to reference types by name (with autocomplete)**
Rather than needing to import every single piece of the schema
- **Interoperable with vanilla `graphql-js` types, and it's _just_ a [`GraphQLSchema`](https://graphql.org/graphql-js/type/#graphqlschema)**
So it fits in just fine with existing community solutions of `apollo-server`, `graphql-middleware`, etc.
- **Inline function resolvers**
For when you need to do simple field aliasing
- **Auto-generated graphql SDL schema**
Great for when seeing how any code changes affected the schema
- **DRY-up schema design**
Create higher level "functions" which wrap common fields
## Example
```ts
import { queryType, stringArg, makeSchema } from 'nexus'
import { GraphQLServer } from 'graphql-yoga'
const Query = queryType({
definition(t) {
t.string('hello', {
args: { name: stringArg() },
resolve: (parent, { name }) => `Hello ${name || 'World'}!`,
})
},
})
const schema = makeSchema({
types: [Query],
outputs: {
schema: __dirname + '/generated/schema.graphql',
typegen: __dirname + '/generated/typings.ts',
},
})
const server = new GraphQLServer({
schema,
})
server.start(() => `Server is running on http://localhost:4000`)
```
More examples can be found in the [`/examples`](./examples) directory:
- [githunt-api](./examples/githunt-api)
- [ts-ast-reader](./examples/ts-ast-reader)
- [apollo-fullstack](./examples/apollo-fullstack)
- [star-wars](./examples/star-wars)
- [kitchen-sink](./examples/kitchen-sink)
## Documentation
You can find the docs for Nexus [here](http://nexusjs.org/).
## Migrate from SDL
If you've been following an [SDL-first](https://www.prisma.io/blog/the-problems-of-schema-first-graphql-development-x1mn4cb0tyl3/) approach to build your GraphQL server and want to see what your code looks like when written with GraphQL Nexus, you can use the [**SDL converter**](https://nexusjs.org/converter).