Latihan 1: API Documentation (OpenAPI) — API

Latihan 1 dari materi API Documentation (OpenAPI) di API — praktek dengan editor kode interaktif, test case otomatis, dan hint terpandu. Langsung jalan di browser.

Lengkapi spec di starter untuk GET /api/products. Baris openapi, info, paths, /api/products, dan get sudah ada, biarkan tetap. openapi: 3.1.0 adalah versi yang dipakai pelajaran ini; yang dinilai bagian di bawah get. Indentasi pakai spasi, bukan tab.

  1. Isi summary, misalnya Get list of products.
  2. Tambahkan parameters: berisi satu butir daftar: - name: category, tepat di bawahnya in: query, lalu required: false dan schema: dengan type: string.
  3. Tambahkan responses: dengan dua kunci status, "200": dan "500":, masing-masing dengan description.
  4. Di bawah "200":, tulis content: → application/json: → schema: dengan type: array dan items: yang menjelaskan satu Product: type: object dan properties: berisi id (type: integer), name (type: string), dan price (type: number).

Tester-nya membaca spec-mu seperti alat OpenAPI sungguhan. YAML-nya harus bisa di-parse: indentasi yang bergeser atau tab ditolak dengan nomor baris dan kolomnya. Lalu dokumennya dicek sebagai OpenAPI 3.1, misalnya summary yang kosong atau response tanpa description ditolak. Sesudah itu tester mencari nilai di tempatnya, di bawah paths → /api/products → get: summary terisi; parameter yang name-nya category punya in: query dan schema dengan type: string; response "200" punya description, dan content → application/json → schema bertipe array yang items-nya object dengan id (integer), name (string), dan price (number); response "500" punya description. Schema yang ditulis di components dan dirujuk dengan $ref juga diikuti.

Hint