Schema visibility control in GraphQL

Introduction

Schema visibility control helps decide which parts of a GraphQL schema users can see or use. It keeps data safe and organized.

When you want to hide some fields from certain users for privacy.

When you want to show only specific queries or mutations to different user roles.

When you want to limit access to sensitive data in a public API.

When you want to simplify the schema for beginner users by hiding advanced features.

When you want to control which parts of the schema are available during development or testing.

Syntax

GraphQL

type Query {
  visibleField: String
  hiddenField: String @deprecated(reason: "Hidden from users")
}

# Or use schema directives or middleware to control visibility

GraphQL itself does not have built-in visibility control, so you use directives or server logic.

You can use custom directives or middleware to hide or show fields based on user roles.

Examples

This example uses a custom @auth directive to show privateData only to logged-in users.

GraphQL

type Query {
  publicData: String
  privateData: String @auth(requires: USER)
}

This example marks a field as deprecated to discourage its use, which can help hide it gradually.

GraphQL

directive @deprecated(reason: String) on FIELD_DEFINITION

type Query {
  oldField: String @deprecated(reason: "Use newField instead")
  newField: String
}

Sample Program

This schema defines an @auth directive to control who can see secretInfo. Only ADMIN users can access it.

GraphQL

directive @auth(requires: Role = USER) on FIELD_DEFINITION

enum Role {
  ADMIN
  USER
  GUEST
}

type Query {
  publicInfo: String
  secretInfo: String @auth(requires: ADMIN)
}

# Server logic checks user role before resolving secretInfo

Important Notes

GraphQL does not enforce visibility by itself; you must add logic in your server code.

Use directives or middleware to check user roles or permissions before returning data.

Hiding fields improves security and user experience by showing only relevant data.

Summary

Schema visibility control limits what users can see or use in a GraphQL schema.

It is done using directives or server-side logic, not built-in GraphQL features.

This helps protect sensitive data and tailor the API to different user needs.

Practice

1. What is the main purpose of schema visibility control in GraphQL?

easy

A. To limit what parts of the schema users can see or access

B. To speed up query execution by caching results

C. To automatically generate schema documentation

D. To convert GraphQL queries into SQL queries

Solution

1. Step 1: Understand schema visibility control concept

   Schema visibility control is about restricting access to parts of the GraphQL schema based on user roles or permissions.

2. Step 2: Identify the main goal

   The goal is to protect sensitive data and tailor the API by limiting what users can see or use.

3. Final Answer:

   To limit what parts of the schema users can see or access -> Option A

4. Quick Check:

   Schema visibility control = limit schema access [OK]

Hint: Focus on access limits, not performance or docs [OK]

Common Mistakes:

• Confusing visibility control with caching
• Thinking it auto-generates docs
• Assuming it converts queries to SQL

2. Which of the following is a correct way to hide a field in a GraphQL schema using a directive?

easy

A. @deprecated(reason: "hidden") on the field

B. @private on the query operation

C. @skip(if: false) on the schema type

D. @hide(if: true) on the field definition

Solution

1. Step 1: Understand directive usage for visibility

   Directives like @hide(if: true) can be used on fields to conditionally hide them based on logic.

2. Step 2: Evaluate options

   @private is not a standard directive; @skip(if: false) means do not skip (show field); @deprecated marks fields as deprecated but does not hide them.

3. Final Answer:

   @hide(if: true) on the field definition -> Option D

4. Quick Check:

   Use conditional directives like @hide to control visibility [OK]

Hint: Look for conditional directive on field, not operation [OK]

Common Mistakes:

• Using @deprecated to hide fields
• Applying directives on queries instead of fields
• Misunderstanding @skip logic

3. Given this schema snippet with a visibility directive:

type User {
  id: ID!
  email: String @hide(if: $isGuest)
  name: String
}

What fields will a guest user see if $isGuest is true?

medium

A. id and name only

B. id, email, and name

C. email and name only

D. id and email only

Solution

1. Step 1: Analyze the directive condition

   The @hide(if: $isGuest) directive hides the email field when $isGuest is true.

2. Step 2: Determine visible fields for guest

   Since $isGuest is true, email is hidden. The visible fields are id and name.

3. Final Answer:

   id and name only -> Option A

4. Quick Check:

   @hide(if: true) hides field = id and name visible [OK]

Hint: True condition hides field, so exclude it [OK]

Common Mistakes:

• Including hidden fields in output
• Confusing @hide with @skip
• Ignoring variable values in directives

4. You wrote this directive to hide a field:

email: String @hide(if: isGuest)

But the field is always visible. What is the likely error?

medium

A. Using @hide on a field is not supported

B. Missing $ before variable name in directive condition

C. The field type String cannot have directives

D. The directive should be @skip, not @hide

Solution

1. Step 1: Check variable usage in directive

   GraphQL variables in directives must be prefixed with $. Here, isGuest is missing $.

2. Step 2: Understand impact of missing $

   Without $, the directive condition is invalid or always false, so the field is never hidden.

3. Final Answer:

   Missing $ before variable name in directive condition -> Option B

4. Quick Check:

   Variables need $ prefix in directives [OK]

Hint: Always prefix variables with $ in directives [OK]

Common Mistakes:

• Forgetting $ before variable in directive
• Assuming @hide is unsupported
• Thinking directives can't be on scalar fields

5. You want to create a GraphQL API that shows users' email only to admins and hides it from regular users. Which approach best implements this schema visibility control?

hard

A. Return null for email in resolver for regular users without schema changes

B. Remove the email field from the schema entirely

C. Use @hide(if: $isNotAdmin) on the email field and pass $isNotAdmin from server context

D. Use @deprecated directive on email field for regular users

Solution

1. Step 1: Identify requirement for conditional visibility

   The email field should be visible only to admins, so visibility depends on user role.

2. Step 2: Evaluate options for controlling visibility

   Use a directive like @hide(if: $isNotAdmin) on the email field and pass $isNotAdmin from server context. This uses a directive with a variable from server context to hide email for non-admins, which is the correct schema visibility control method.

3. Step 3: Understand why other options fail

   Removing the field removes it for all users; @deprecated only marks as outdated; returning null hides data but not schema field.

4. Final Answer:

   Use @hide(if: $isNotAdmin) on the email field and pass $isNotAdmin from server context -> Option C

5. Quick Check:

   Use conditional directives with server variables for visibility [OK]

Hint: Use directives with server variables for role-based hiding [OK]

Common Mistakes:

• Removing fields instead of hiding conditionally
• Using @deprecated to hide fields
• Returning null but not hiding schema field