XuJiacheng
0bdaf54eed
- 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
48 lines
1.9 KiB
YAML
48 lines
1.9 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: BAI PocketBase Native API
|
|
version: 1.0.0-wx-folder
|
|
description: |
|
|
本目录仅收敛 PocketBase 原生 API 文档，不包含自定义 hooks API。
|
|
|
|
文档约定：
|
|
- 不单独配置鉴权组件；如接口需要登录，请直接在说明中关注 `Authorization: Bearer <token>`
|
|
- 示例字段值统一使用 `<字段说明>|<类型>` 风格
|
|
- 原生接口返回 PocketBase 标准 records 结构，不使用 hooks 统一响应信封
|
|
servers:
|
|
- url: https://bai-api.blv-oa.com
|
|
description: 生产环境
|
|
- url: http://127.0.0.1:8090
|
|
description: PocketBase 本地环境
|
|
tags:
|
|
- name: 企业信息
|
|
description: PocketBase 原生公司记录接口
|
|
- name: 附件信息
|
|
description: PocketBase 原生附件记录接口
|
|
- name: 产品信息
|
|
description: PocketBase 原生产品记录接口
|
|
- name: 文档信息
|
|
description: PocketBase 原生文档记录接口
|
|
- name: 购物车
|
|
description: PocketBase 原生购物车记录接口
|
|
- name: 订单
|
|
description: PocketBase 原生订单记录接口
|
|
paths:
|
|
/pb/api/collections/tbl_company/records:
|
|
$ref: './company.yaml#/paths/companyRecords'
|
|
/pb/api/collections/tbl_company/records/{recordId}:
|
|
$ref: './company.yaml#/paths/companyRecordById'
|
|
/pb/api/collections/tbl_attachments/records:
|
|
$ref: './attachments.yaml#/paths/attachmentRecords'
|
|
/pb/api/collections/tbl_product_list/records:
|
|
$ref: './products.yaml#/paths/productRecords'
|
|
/pb/api/collections/tbl_document/records:
|
|
$ref: './documents.yaml#/paths/documentRecords'
|
|
/pb/api/collections/tbl_cart/records:
|
|
$ref: './cart.yaml#/paths/cartRecords'
|
|
/pb/api/collections/tbl_cart/records/{recordId}:
|
|
$ref: './cart.yaml#/paths/cartRecordById'
|
|
/pb/api/collections/tbl_order/records:
|
|
$ref: './order.yaml#/paths/orderRecords'
|
|
/pb/api/collections/tbl_order/records/{recordId}:
|
|
$ref: './order.yaml#/paths/orderRecordById' |