Skip to content

Using GraphQL Directives

Directive recipes against the Sample Application schema. For the full directive reference see Directives.

String Formatting

query GetPostFormatted {
  post(id: "1") {
    title @uppercase
    excerpt @capitalize
    author {
      username @title_case
      email @lowercase
    }
    content @strip
  }
}

{
  "data": {
    "post": {
      "title": "GETTING STARTED WITH GRAPHQL AND DJANGO",
      "excerpt": "Learn the basics of integrating graphql with django",
      "author": {
        "username": "John Doe",
        "email": "john@example.com"
      },
      "content": "GraphQL is a powerful query language for APIs..."
    }
  }
}

Number Formatting

query GetPostStats {
  allPosts(filter: { status: { exact: PUBLISHED } }) {
    results {
      id
      title
      viewCount @number(as: ",.0f")
      createdAt @date(format: "YYYY-MM-DD")
    }
    totalCount
  }
}

{
  "data": {
    "allPosts": {
      "results": [
        {
          "id": "1",
          "title": "Getting Started with GraphQL",
          "viewCount": "1,245",
          "createdAt": "2023-12-01"
        },
        {
          "id": "2",
          "title": "Advanced Django Techniques",
          "viewCount": "892",
          "createdAt": "2023-11-28"
        }
      ],
      "totalCount": 2
    }
  }
}

Date Formatting

query GetPostDates {
  post(id: "1") {
    title
    createdAt @date(format: "MMMM DD, YYYY")
    publishedAt @date(format: "DD/MM/YYYY HH:mm")
    updatedAt @date(format: "iso")
  }
}

{
  "data": {
    "post": {
      "title": "Getting Started with GraphQL and Django",
      "createdAt": "December 01, 2023",
      "publishedAt": "01/12/2023 14:30",
      "updatedAt": "2023-12-01T14:30:00"
    }
  }
}

ISO format

@date(format: "iso") outputs the real ISO 8601 format (%Y-%m-%dT%H:%M:%S — e.g. "2023-12-01T14:30:00"). Prior to v1.2.1 the output incorrectly used %Y-%b-%dT%H:%M:%S (abbreviated month name such as "2023-Dec-01T14:30:00"), which is not valid ISO 8601.