Query API

If you just want to try it out, you can use this Craft Nuxt Starter.

The Query API allows developers to create queries directly from URL parameters, enabling fast and flexible data quering in JS Frameworks.

Paired with nuxt-craftcms you can query data in nuxt like you are used to from twig:

const { data } = await useCraftEntry()
  .section('news')
  .limit(3)
  .all()

Features

• Comprehensive Content API: Supports querying for addresses, assets, entries, and users, providing a complete Content API for Craft CMS.

• Bearer Token Auth: Define schemas and bearer tokens in the controlpanel to control who can access your data.

• Auto TypeScript Generation: Auto generate all types of your Craft CMS elements with one single command.

• Get Only the Data You Need: Avoid overfetching by using a custom function in the query builder to select only the fields you require.

• Pretty JSON Responses: JSON Transformers prettify the response for better readability.

• Native and Custom Field Detection: Automatically detects native Craft CMS fields and custom fields across all element types.

• Prerendering Helper: Fetch all active page URLs for prerendering, static site generation.

• Optimized Data Retrieval: High-performance content access with smart caching strategies ensures your queries run fast.

• Extensible: You can add your own Json Transformer and custom element types to the Query API.

• ImagerX Support: When querying images, it can return the optimized srcset generated by ImagerX.

Access Control with Schemas

Schemas allow you to define fine-grained access control for your data. Each access token is associated with one schema, which defines what content the token can access. This ensures a secure and predictable way of querying data via the API.

When creating a schema, you can assign permissions for specific content types, such as:

• Site
• Section
• Volume
• User Group
• Address
• Custom element types

This setup gives you full flexibility to tailor access to your needs - for example, restricting a token to only a specific section or user group.

Why not GraphQl?

Productivity

GraphQL requires detailed schemas, fragments, which can feel counterproductive for developers focused on efficiency.

Steep Learning Curve

If you're new to GraphQL, the syntax, schema design, error handling and tooling like Apollo can take significant time to learn. The Craft Query API Plugin works right out of the box like you were used to in twig.

Overhead and Architectural Complexity

Flexibility in GraphQL leads to a lot things you have to think of. Maintainability and error handling is hard with graphQl. The Craft CMS Query API eliminates this overhead.

Available Integrations

The Craft Query API offers several integrations for modern frontend frameworks:

• Js Craft CMS API: The core package, you can build wrappers around it to support your framework. If you want to build a wrapper around it for your framework -> Hit me up :)

• Vue Craft CMS: A package to use the query builder in Vue.

• Nuxt Craft CMS: A package to use the query builder in Nuxt.