_using-the-graphql-api-typegraphql.md

Using the GraphQL API

The schema specifies the API operations of your GraphQL server. TypeGraphQL allows you to define a schema using TypeScript classes and decorators. The schema is generated at runtime, and is defined by the following classes:

• ./src/PostResolvers.ts
• ./src/UserResolvers.ts
• ./src/User.ts
• ./src/Post.ts
• ./src/UserCreateInput.ts
• ./src/PostCreateInput.ts

Below are a number of operations that you can send to the API using the GraphQL Playground.

Feel free to adjust any operation by adding or removing fields. The GraphQL Playground helps you with its auto-completion and query validation features.

Retrieve all published posts and their authors

query {
  feed {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

See more API operations

Create a new user

mutation {
  signupUser(data: {
    name: "Sarah",
    email: "[email protected]"
    }
  ) {
    id
  }
}

Create a new draft

mutation {
  createDraft(
    data: {
      title: "Join the Prisma Slack",
      content: "https://slack.prisma.io"
      email: "[email protected]"
    }
  ) {
    id
    published
  }
}

Publish an existing draft

mutation {
  publish(id: __POST_ID__) {
    id
    published
  }
}

Note: You need to replace the __POST_ID__-placeholder with an actual id from a Post item. You can find one e.g. using the filterPosts-query.

Search for posts with a specific title or content

{
  filterPosts(searchString: "graphql") {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

Retrieve a single post

{
  post(id: __POST_ID__) {
    id
    title
    content
    published
    author {
      id
      name
      email
    }
  }
}

Note: You need to replace the __POST_ID__-placeholder with an actual id from a Post item. You can find one e.g. using the filterPosts-query.

Delete a post

mutation {
  deleteOnePost(id: __POST_ID__) {
    id
  }
}

Note: You need to replace the __POST_ID__-placeholder with an actual id from a Post item. You can find one e.g. using the filterPosts-query.