@django-headles/客户

API 的 TypeScript 客户端 强哥无头生成一个 REST API 用于您的 Django 模型。 请求从前端或静态站点构建中生成的路由,其类型来自API的OpenAPI schema.

阅读文档地址 djangoheadless.org/docs/客户。 。 。 .

特征

• 每个模型的路线:列表,检索,检索,创建,更新和删除,以及单子的路由.
• 生成类型:每个被曝光的模型的接口,由OpenAPI schema所生成.
• 输入的查询:过滤,排除,搜索,订购和页码,并附字段类型.
• 已输入扩展: 响应类型如下 expand, (中文(简体) ), fields 财务报告和审定财务报表 omit。 。 。 .
• 无依赖关系: 借鉴 fetch,对于Node.js 18以及后来的浏览器和边缘运行时间.

快开始

1. 安装软件包 :

   npm install @django-headless/client
   

2. 启用 API 的计划 HEADLESS["SCHEMA"],生成类型:

   npx headless generate --url https://example.org/api/schema --out src/headless.ts
   

   命令从 DJANGO_HEADLESS_SECRET_KEY 环境变量.

3. 请 API :

   // src/api.ts
   import { DjangoRestClient } from "@django-headless/client";
   import type { Models } from "./headless";
   
   const api = new DjangoRestClient<Models>({
       baseUrl: "https://example.org/api",
       secretKey: process.env.HEADLESS_SECRET_KEY,
   });
   
   const { data } = await api.model("blog.article").list({
       filters: { published: true },
       expand: ["category"],
   });
   

许可证

麻省理工学院