mirrors/nocobase
1
0
Fork 0
mirror of https://github.com/nocobase/nocobase synced 2024-11-15 18:37:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
460dbcbc7f
nocobase/docs/en-US/development/http-api/rest-api.md
Ryan Russell ec34c34e31
docs(various): Improve readability (#447) 
Signed-off-by: Ryan Russell <git@ryanrussell.org>
2022-06-01 09:27:18 +08:00

2.6 KiB
Raw Blame History

REST API

NocoBase's HTTP API is a superset of the REST API, and the standard CRUD API also supports the RESTful style.

Collection resources

Create collection

HTTP API

POST  /api/<collection>:create

{} # JSON body

REST API

POST  /api/<collection>

{} # JSON body

List collection

HTTP API

GET   /api/<collection>:list

REST API

GET   /api/<collection>

View collection details

HTTP API

GET   /api/<collection>:get?filterByTk=<collectionIndex>
GET   /api/<collection>:get/<collectionIndex>

REST API

GET   /api/<collection>/<collectionIndex>

Update collection

HTTP API

POST   /api/<collection>:update?filterByTk=<collectionIndex>

{} # JSON body

# Or
POST   /api/<collection>:update/<collectionIndex>

{} # JSON body

REST API

PUT    /api/<collection>/<collectionIndex>

{} # JSON body

Delete collection

HTTP API

POST      /api/<collection>:destroy?filterByTk=<collectionIndex>
# Or
POST      /api/<collection>:destroy/<collectionIndex>

REST API

DELETE    /api/<collection>/<collectionIndex>

Association resources

Create Association

HTTP API

POST    /api/<collection>/<collectionIndex>/<association>:create

{} # JSON body

REST API

POST    /api/<collection>/<collectionIndex>/<association>

{} # JSON body

List Association

HTTP API

GET   /api/<collection>/<collectionIndex>/<association>:list

REST API

GET   /api/<collection>/<collectionIndex>/<association>

View Association details

HTTP API

GET   /api/<collection>/<collectionIndex>/<association>:get?filterByTk=<associationIndex>
# Or
GET   /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>

REST API

GET   /api/<collection>/<collectionIndex>/<association>:get/<associationIndex>

Update Association

HTTP API

POST   /api/<collection>/<collectionIndex>/<association>:update?filterByTk=<associationIndex>

{} # JSON body

# Or
POST   /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>

{} # JSON body

REST API

PUT    /api/<collection>/<collectionIndex>/<association>:update/<associationIndex>

{} # JSON

Delete Association

HTTP API

POST    /api/<collection>/<collectionIndex>/<association>:destroy?filterByTk=<associationIndex>
# Or
POST    /api/<collection>/<collectionIndex>/<association>:destroy/<associationIndex>

REST API

DELETE  /api/<collection>/<collectionIndex>/<association>/<associationIndex>