kql
nuxt-kirby

用于 Kirby Query Language API 的 Nuxt 模块

Nuxt Kirby module

Nuxt Kirby

Nuxt 模块,用于与 Kirby CMS 交互,并支持 Kirby 的查询语言 API。

功能

  • 🔒 发送查询时保护 Kirby 凭据
  • 🪢 支持使用 Kirby Headless 插件 进行基于令牌的身份验证(推荐)
  • 🍱 处理请求就像使用 useFetch 组合式函数一样
  • 🦦 提供 多个入门套件
  • 🗃 缓存查询响应
  • 🤹 没有 CORS 问题!
  • 🦾 强类型

设置

!TIP📖 阅读文档

npx nuxi@latest module add kirby

基本用法

!TIP📖 阅读文档

将 Nuxt Kirby 模块添加到您的 Nuxt 配置中

// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-kirby']
})

并在您的模板中发送查询

<script setup lang="ts">
const { data, error, status } = await useKql({
  query: 'site'
})
</script>

<template>
  <div>
    <h1>{{ data?.result?.title }}</h1>
    <pre>{{ JSON.stringify(data?.result, undefined, 2) }}</pre>
  </div>
</template>

💻 开发

  1. 克隆此仓库
  2. 使用 corepack enable 启用 Corepack
  3. 使用 pnpm install 安装依赖
  4. 运行 pnpm run dev:prepare
  5. 使用 pnpm run dev 启动开发服务器

许可证

MIT 许可证 © 2022-PRESENT Johann Schopplich