Ikhtisar API
Namespace gitdocs/v1, format permintaan dan respons, serta daftar seluruh endpoint.
Di halaman ini
GitDocs menambahkan namespace REST gitdocs/v1 di atas REST API WordPress. Endpoint inilah yang dipakai editor bawaan, sehingga apa pun yang bisa dilakukan editor juga bisa Anda otomatiskan.
https://situs.id/wp-json/gitdocs/v1/| Metode | Rute | Kapabilitas | Kegunaan |
|---|---|---|---|
| GET | /search-index |
publik | Indeks pencarian JSON |
| POST | /feedback |
publik | Kirim "membantu / tidak" |
| POST | /render |
edit_posts |
Markdown β HTML (pratinjau) |
| GET | /spaces |
edit_posts |
Daftar space |
| POST | /spaces |
manage_categories |
Buat space |
| POST | /spaces/{id} |
manage_categories |
Perbarui space |
| GET | /tree |
edit_posts |
Pohon halaman satu space |
| POST | /tree |
edit_post per item |
Susun ulang pohon |
| POST | /pages |
edit_posts |
Buat halaman |
| GET | /pages/{id} |
edit_post |
Data halaman untuk editor |
| POST | /pages/{id} |
edit_post |
Simpan / terbitkan |
| DELETE | /pages/{id} |
delete_post |
Pindahkan ke tempat sampah |
| POST | /pages/{id}/rename |
edit_post |
Ganti judul |
| POST | /pages/{id}/props |
edit_post |
Ikon / status grup |
| POST | /pages/{id}/discard |
edit_post |
Buang perubahan belum terbit |
| POST | /pages/{id}/unpublish |
edit_post |
Kembalikan ke draf |
| POST | /pages/{id}/lock |
edit_post |
Ambil alih kunci edit |
| POST | /pages/{id}/space |
edit_post |
Pindahkan ke space lain |
Permintaan dan respons memakai JSON (Content-Type: application/json). Nama properti memakai camelCase agar langsung cocok dengan editor React.
{
"id": 42,
"title": "Instalasi",
"slug": "instalasi",
"status": "publish",
"markdown": "## Persyaratan\n\nβ¦",
"icon": "π¦",
"isGroup": false,
"hasDraft": false,
"permalink": "https://situs.id/docs/panduan/memulai/instalasi/"
}Kesalahan memakai format standar WordPress:
{
"code": "gitdocs_locked",
"message": "Halaman ini sedang diedit oleh Rina.",
"data": { "status": 409, "user": "Rina" }
}| Kode | Status | Arti |
|---|---|---|
rest_forbidden |
401/403 | Kapabilitas kurang, atau nonce tidak sah |
rest_post_invalid_id |
404 | Halaman tidak ada atau bukan doc_page |
gitdocs_locked |
409 | Halaman sedang diedit orang lain |
gitdocs_cycle |
400 | Halaman hendak dijadikan induk dirinya sendiri |
gitdocs_bad_tree |
400 | Struktur pohon tidak valid |
gitdocs_no_space |
400/404 | Space tidak ditemukan |
gitdocs_already_voted |
429 | Masukan sudah dikirim hari ini |
Endpoint tulis tidak pernah mengandalkan status login saja: setiap rute memeriksa kapabilitas untuk objek yang diubah. Lihat Autentikasi.