Usa i campi per documentare i parametri e le risposte delle API. Esistono due tipi di campi: campi parametro e campi risposta.

​
Campo parametro

Il componente <ParamField> viene utilizzato per definire i parametri delle tue API o dei tuoi SDK. L’aggiunta di un ParamField aggiunge automaticamente un API playground.
​
param
string
required
Un esempio di campo parametro
<ParamField path="param" type="string" required>
  Un esempio di campo parametro
</ParamField>

​
Proprietà

​
query, path, body, or header
string
Specifica se il parametro è una query, un path, un body o un header. Seguito dal nome del parametro.
​
type
string
Tipo previsto per il valore del parametro.Supporta number, string, boolean, object.Gli array possono essere definiti usando il suffisso []. Ad esempio string[].
​
required
boolean
Indica se il parametro è obbligatorio.
​
deprecated
boolean
Indica se il parametro è obsoleto.
​
default
any
Valore predefinito utilizzato quando il valore della richiesta è vuoto
​
placeholder
string
Testo segnaposto per l’input nel playground.
​
children
string
Descrizione del parametro (supporta Markdown).

​
Campo di risposta

Il componente <ResponseField> definisce i valori restituiti da un’API.
​
response
string
required
Un esempio di campo di risposta
<ResponseField name="response" type="string" required>
  Un esempio di campo di risposta
</ResponseField>

​
Proprietà

​
name
string
required
Il nome del valore di risposta.
​
type
string
required
Tipo atteso del valore di risposta. Può essere qualsiasi stringa arbitraria.
​
default
string
Il valore predefinito.
​
required
boolean
Indica se la risposta è obbligatoria.
​
deprecated
boolean
Indica se un campo è obsoleto.
​
pre
string[]
Etichette visualizzate prima del nome del campo.
​
post
string[]
Etichette visualizzate dopo il nome del campo.