Fields

Ada dua jenis field: Field Parameter dan Field Respons.

Field Parameter

KomponenParamFielddigunakan untuk mendefinisikan parameter untuk API atau SDK Anda. MenambahkanParamFieldakan secara otomatis menambahkanAPI Playground.

param · string · required

Contoh field parameter

Path Example

<ParamField path="param" type="string">
  An example of a parameter field
</ParamField>

Props

query, path, body, or header · string

Apakah itu parameter query, path, body, atau header diikuti dengan nama

type · string

Tipe yang diharapkan dari nilai parameter

Mendukungnumber,string,bool,object.

Array dapat didefinisikan menggunakan akhiran[]. Misalnyastring[].

required · boolean

Menunjukkan apakah parameter diperlukan

deprecated · boolean

Menunjukkan apakah parameter sudah usang

default · string

Nilai default yang digunakan oleh server jika permintaan tidak menyediakan nilai

initialValue · any

Nilai yang akan digunakan untuk menginisialisasi playground

placeholder · string

Teks placeholder untuk input di playground

children · string

Deskripsi parameter (markdown diaktifkan)

Field Respons

Komponen<ResponseField>dirancang untuk mendefinisikan nilai kembali dari API. Banyak dokumentasi juga menggunakan<ResponseField>pada halaman ketika Anda perlu mendaftar tipe sesuatu.

response · string · required

Contoh field respons

<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>

Props

name · string · required

Nama nilai respons.

type · string · required

Tipe yang diharapkan dari nilai respons - ini bisa berupa string arbitrer apa pun.

default · string

Nilai default.

required · boolean

Tampilkan “required” di samping nama field.

deprecated · boolean

Apakah suatu field sudah usang atau tidak.

pre · string[]

Label yang ditampilkan sebelum nama field

post · string[]

Label yang ditampilkan setelah nama field