Dokumentasi

Deployment

Dokumentasi disediakan langsung oleh MocoBaaS saat berjalan pada server, pengembang dapat melakukan akses via HTTP path /swagger/tables untuk Tables dan /swagger/customapi untuk Script.

Console

Dalam Console, dokumentasi dapat diakses dengan menekan menu Documentation. Akan muncul 3 (tiga) tab jenis dokumentasi Instant API yang menggunakan standar OpenAPI pada mainview.

  • Tables
    Dokumentasi terkait operasi CRUD pada seluruh tabel. Format response yang digunakan adalah JSON:API.
  • Scripts
    Dokumentasi terkait operasi terkait custom script yang dipicu melalui HTTP (webhook) dan Client-SDK.
  • Common API
    Dokumentasi terkait fungsionalitas standar pada MocoBaaS, diantaranya mencakup otentikasi, notifikasi dan storage. Format response menyesuaikan dengan JSON:API.

image 1