Ringkasan eksekutif
PetStore Mock API adalah project Boomi Web Services kecil yang meniru dua operasi Swagger Petstore publik: ambil pet berdasarkan ID dan buat pet. Project ini memberi tim front-end dan integrasi endpoint yang stabil untuk dikembangkan sebelum back end sebenarnya tersedia.
Project ini juga menjadi referensi rapi untuk pola berlapis yang dipakai di project yang lebih besar: proses listener yang tipis, sub-proses berisi logika bisnis, profil JSON sebagai kontrak, dan respons error bergaya Petstore.
Tujuan
Membuka jalan tim klien
Developer front-end dan mobile langsung mendapat API yang kompatibel dengan Petstore sejak hari pertama.
Uji kontrak
Respons yang dapat diprediksi — termasuk error — memudahkan pengujian penanganan error di klien.
Pola referensi
Menunjukkan pola API → [SUB], decision regex, dan respons Message-shape dalam bentuk paling sederhana.
Yang didemonstrasikan
Web Services Server
Mengekspos proses Boomi sebagai endpoint REST di shared web server Atom Cloud.
Parameter query sebagai DPP
petId diterima sebagai dynamic process property query_petId.
Profil JSON
j.PetStore.Pet mengikuti skema Pet Swagger Petstore dan dipakai untuk akses field di decision.
Validasi input
Decision regex menolak ID yang salah dan nama kosong sebelum langkah lain berjalan.
Error yang konsisten
Error memakai bentuk ApiResponse Petstore: code, type, message.
Observabilitas
Shape Notify mencatat setiap pet yang diterima di process log.
Arsitektur solusi
Referensi API
Base URL: https://<atom-cloud>/ws/simple · autentikasi Basic dengan user shared web server Atom Cloud.
| Endpoint Boomi | Swagger Petstore | Proses | Input → output |
|---|---|---|---|
GET /getPetstorePet?petId= | GET /pet/{petId} | PetStore API - Get Pet | tidak ada → single data |
POST /createPetstorePet | POST /pet | PetStore API - Create Pet | single JSON → single data |
Skema Pet (profil j.PetStore.Pet)
| Field | Tipe | Keterangan |
|---|---|---|
id | integer (int64) | ID pet |
category | object {id, name} | Kategori |
name | string | Wajib — harus berisi minimal satu karakter selain spasi |
photoUrls | array of string | URL foto |
tags | array of {id, name} | Tag |
status | string | available | pending | sold |
Respons
| Kasus | HTTP | Body |
|---|---|---|
| GET dengan petId angka | 200 | Pet mock “doggie” dengan id yang diminta |
| GET dengan petId kosong atau bukan angka | 200 | {"code": 400, "type": "error", "message": "Invalid ID supplied"} |
| POST dengan nama | 200 | Body request, dikembalikan apa adanya |
| POST tanpa nama yang valid | 200 | {"code": 405, "type": "error", "message": "Invalid input: pet name is required"} |
type == "error" di body.Contoh
curl -u "$BOOMI_USER:$BOOMI_TOKEN" \ "https://<atom-cloud>/ws/simple/getPetstorePet?petId=123"
{ "id": 123, "category": {"id": 1, "name": "Dogs"}, "name": "doggie",
"photoUrls": ["https://petstore.swagger.io/photos/doggie.jpg"],
"tags": [{"id": 1, "name": "friendly"}], "status": "available" }curl -u "$BOOMI_USER:$BOOMI_TOKEN" -X POST -H "Content-Type: application/json" \
"https://<atom-cloud>/ws/simple/createPetstorePet" \
-d '{"id": 10, "name": "Bobby", "category": {"id": 1, "name": "Dogs"}, "status": "available"}'Desain proses
| Proses | Shape | Logika |
|---|---|---|
| PetStore API - Get Pet | Start (WSS Listen: PetStore WSS Get Pet) → Process Call → Return Documents | Menerima GET, meneruskan request ke sub-proses. |
| [SUB] PetStore Get Pet | Start (passthrough) → Decision “Valid Pet ID?” → Message → Return Documents | query_petId cocok dengan ^[0-9]+$ → Pet mock dengan id tersebut; selain itu ApiResponse 400. |
| PetStore API - Create Pet | Start (WSS Listen: PetStore WSS Create Pet) → Process Call → Return Documents | Menerima body JSON, meneruskannya ke sub-proses. |
| [SUB] PetStore Create Pet | Start (passthrough) → Decision “Pet Name Provided?” → Notify / Message → Return Documents | name cocok dengan .*\S.* → Notify “Pet accepted: {1}” dan body dikembalikan; selain itu ApiResponse 405. |
Keputusan desain
- Listener tipis, logika mudah diuji. Proses [SUB] memakai start passthrough, sehingga bisa dijalankan di Test Mode dengan dokumen contoh — tanpa perlu panggilan HTTP.
- Decision regex membuat validasi eksplisit dan terlihat di canvas.
- Message shape menghasilkan JSON Petstore yang persis sama, sehingga klien yang dibuat untuk Swagger Petstore bisa langsung dipakai.
- Tanpa penyimpanan secara sengaja: mock bersifat stateless dan aman dipanggil berulang kali.
Kasus uji
| # | Request | Hasil yang diharapkan |
|---|---|---|
| 1 | GET petId=123 | Pet doggie, id 123 |
| 2 | GET petId=abc | ApiResponse 400 |
| 3 | GET petId=-1 | ApiResponse 400 (tanda minus bukan digit) |
| 4 | GET tanpa petId | ApiResponse 400 |
| 5 | POST dengan nama “Bobby” | Body dikembalikan; “Pet accepted” di process log |
| 6 | POST tanpa nama | ApiResponse 405 |
| 7 | POST dengan nama hanya spasi | ApiResponse 405 |
| 8 | POST dengan body kosong | ApiResponse 405 |
Semua kasus dapat dijalankan secara interaktif di konsol web.
Mockup konsol web
Konsol statis menjalankan kedua endpoint di browser dengan logika yang sama seperti proses Boomi.
API Console
Susun request GET atau POST, pakai preset untuk setiap kasus uji, dan baca body, header, process log, serta cURL.
Jalur eksekusi
Diagram proses menyorot cabang yang dilalui setiap request.
Pet Shop Demo
Toko kecil yang menambah pet lewat POST dan mengambilnya lewat GET.
Referensi API
Endpoint, skema, respons, dan contoh cURL.
Riwayat request
Setiap request dalam sesi; klik untuk menjalankan ulang.
Jalan di mana saja
HTML, CSS, dan JavaScript biasa di GitHub Pages; tema terang dan gelap.
Komponen
| Jenis | Komponen | Fungsi |
|---|---|---|
| Process (WSS) | PetStore API - Get Pet | Listener untuk GET getPetstorePet |
| Process (WSS) | PetStore API - Create Pet | Listener untuk POST createPetstorePet |
| Sub-process | [SUB] PetStore Get Pet | Validasi petId, bangun Pet mock |
| Sub-process | [SUB] PetStore Create Pet | Validasi nama, catat log, dan kembalikan body |
| Connector operation | PetStore WSS Get Pet | Web Services Server · GET · input none · output single data |
| Connector operation | PetStore WSS Create Pet | Web Services Server · CREATE · input single JSON · output single data |
| JSON profile | j.PetStore.Pet | Skema Pet Swagger Petstore |
Struktur repositori
active-development/— XML komponen Boomi (proses, operasi, profil).portal/— mockup konsol web statis.docs/— dokumentasi ini (sumber didocs/_source/)..env.example— pengaturan yang diperlukan untuk push dan deploy; salin ke.env(tidak pernah di-commit).
Penyiapan & deployment
- Salin
.env.exampleke.envlalu isi akun Boomi, API token, folder tujuan, environment, dan test atom. - Push komponen di
active-development/ke folder platform. - Deploy PetStore API - Get Pet dan PetStore API - Create Pet ke environment Atom Cloud dengan shared web server aktif.
- Panggil endpoint dengan user shared web server (Basic auth) dan jalankan kasus uji di atas.
Keterbatasan & langkah berikutnya
Data GET statis
GET selalu mengembalikan “doggie”; pet yang dibuat tidak disimpan.
Kode status HTTP
Atur status HTTP (400/405) lewat header respons agar klien tidak perlu memeriksa body.
Penyimpanan
Simpan pet di database atau Disk V2 dan cari berdasarkan id.
Operasi tambahan
Tambahkan PUT /pet, DELETE /pet/{petId}, dan findByStatus.
API Management
Publikasikan lewat komponen Boomi API Service dengan spesifikasi OpenAPI.
Validasi skema
Validasi status terhadap available | pending | sold serta tipe setiap field.