← Kembali ke Dokumentasi
Contoh dokumentasi backend

bruno-collection.md

docs/bruno-collection.md

Contoh isi file untuk sistem antrian. Sesuaikan dengan implementasi proyek Anda.

# Bruno Collection — Mandatory

Collection berada di [docs/03-api/bruno/](03-api/bruno/). Lokasinya satu kelompok dengan [OpenAPI](03-api/openapi.yaml), [authentication](03-api/authentication.md), dan [error codes](03-api/error-codes.md).

## Contoh yang tersedia

| Urutan | Request | Hasil |
| --- | --- | --- |
| 1 | auth/login.bru | 200; access_token disimpan sebagai runtime variable |
| 2 | antrian/create-antrian.bru | 201; antrian_id disimpan sebagai runtime variable |
| 3 | antrian/detail-antrian.bru | 200; ID response sesuai hasil create |

Endpoint tersebut adalah contoh, bukan API yang tersedia di portal. Siapkan backend sesuai kontrak atau ubah contoh mengikuti implementasi proyek.

## Cara mencoba

Buka docs/03-api/bruno/ di Bruno, pilih local, dan sesuaikan base_url. Sediakan LOGIN_EMAIL dan LOGIN_PASSWORD pada environment proses lokal Bruno. Jalankan request berurutan; assertion akan memeriksa status, response/message, dan hasil bisnis. Gunakan idempotency_key baru untuk pendaftaran baru, serta key dan body yang sama untuk retry.

staging memakai domain .invalid sebagai placeholder. production.bru.example adalah template; file production.bru lokal diabaikan Git. Jangan commit credential. Gunakan local/staging untuk pengujian yang mengubah data.

## Standar

Setiap endpoint aktual wajib memiliki request, grouping domain, autentikasi, variable, dokumentasi response/error, dan assertion yang relevan. Tambahkan skenario validation failure, unauthorized, forbidden, conflict, dan not found sesuai kontrak; tiga contoh yang tersedia saat ini adalah happy path.

Perbarui collection bersama kode pada MR. Bruno melengkapi unit/integration test. OpenAPI terpisah opsional; jika digunakan harus sinkron.

Referensi format: [Bruno — Bru Markup Language](https://docs.usebruno.com/bru-lang/overview).