796e73ae5a
* refactor(doc): change to new structure * docs: add database docs * docs: add collection docs * docs: add db field examples * docs(api): fix filename and menu path * docs: add database docs * docs: add db operators doc * docs: add resourcer menu * docs: add resourcer docs * docs: fix api docs * docs: refactor api menu structure * feat: update docs (#830) * feat: updates * feat: update docs * chore: ignore docs from ci Co-authored-by: Junyi <mytharcher@users.noreply.github.com> Co-authored-by: mytharcher <mytharcher@gmail.com> * docs: add database methods docs * docs: add missed api * docs: fix api docs * feat: update development docs (#833) * feat: update development docs * feat: update docs * feat: update docs * docs: add first plugin example (#834) * feat: update docs * feat: update docs * docs: fix typo Co-authored-by: chenos <chenlinxh@gmail.com>
2.6 KiB
2.6 KiB
REST API
NocoBase 的 HTTP API 是 REST API 的超集，标准的 CRUD API 也支持 RESTful 风格。
Collection 资源
创建 collection
HTTP API
POST /api/<collection>:create
{} # JSON body
REST API
POST /api/<collection>
{} # JSON body
查看 collection 列表
HTTP API
GET /api/<collection>:list
REST API
GET /api/<collection>
查看 collection 详情
HTTP API
GET /api/<collection>:get?filterByTk=<collectionIndex>
GET /api/<collection>:get/<collectionIndex>
REST API
GET /api/<collection>/<collectionIndex>
更新 collection
HTTP API
POST /api/<collection>:update?filterByTk=<collectionIndex>
{} # JSON body
# 或者
POST /api/<collection>:update/<collectionIndex>
{} # JSON body
REST API
PUT /api/<collection>/<collectionIndex>
{} # JSON body
删除 collection
HTTP API
POST /api/<collection>:destroy?filterByTk=<collectionIndex>
# 或者
POST /api/<collection>:destroy/<collectionIndex>
REST API
DELETE /api/<collection>/<collectionIndex>
Association 资源
创建 Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:create
{} # JSON body
REST API
POST /api/<collection>/<collectionIndex>/<association>
{} # JSON body
查看 Association 列表
HTTP API
GET /api/<collection>/<collectionIndex>/<association>:list
REST API
GET /api/<collection>/<collectionIndex>/<association>
查看 Association 详情
HTTP API
GET /api/<collection>/<collectionIndex>/<association>:get?filterByTk=<associationIndex>
# 或者
GET /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>
REST API
GET /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>
更新 Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:update?filterByTk=<associationIndex>
{} # JSON body
# 或者
POST /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>
{} # JSON body
REST API
PUT /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>
{} # JSON 数据
删除 Association
HTTP API
POST /api/<collection>/<collectionIndex>/<association>:destroy?filterByTk=<associationIndex>
# 或者
POST /api/<collection>/<collectionIndex>/<association>:destroy/<associationIndex>
REST API
DELETE /api/<collection>/<collectionIndex>/<association>/<associationIndex>