Point de terminaison d'API

2 min

Point de terminaison API les blocs affichent une documentation API interactive, y compris les paramètres de requête, les exemples de code et les exemples de réponse.

Syntaxe

Vous pouvez ajouter ce composant en utilisant la syntaxe Markdown ou MDX.

Markdown

MDX

:::::ApiMethodV2
(JSON configuration with name, method, url, request, examples, results)
:::::

<ApiMethodV2>
(JSON configuration with name, method, url, request, examples, results)
</ApiMethodV2>

La configuration JSON prend en charge les groupes de paramètres suivants :

paramètres de chemin

parametresDeRequete

paramètres d'en-tête

bodyDataParameters

formDataParameters

Vous pouvez également inclure des exemples de requête et des exemples de réponse dans plusieurs langues.

Lorsqu’ils sont utilisés dans une mise en page à deux colonnes, les blocs de points de terminaison API sont affichés dans la colonne de droite.

Exemple MDX

L’exemple suivant crée un point de terminaison permettant de récupérer un utilisateur, y compris les paramètres de requête, plusieurs exemples de code et des exemples de réponse.

<ApiMethodV2>
{
  "name": "Get User",
  "method": "GET",
  "url": "https://api.example.com/users/{id}",
  "description": "Retrieve a user by their unique ID.",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "js-example",
        "language": "javascript",
        "code": "const res = await fetch('https://api.example.com/users/usr_abc123', {\n  headers: { 'Authorization': 'Bearer sk_live_xxx' }\n})\nconst user = await res.json()",
        "customLabel": ""
      },
      {
        "id": "curl-example",
        "language": "bash",
        "code": "curl https://api.example.com/users/usr_abc123 \\\n  -H 'Authorization: Bearer sk_live_xxx'",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "js-example"
  },
  "results": {
    "languages": [
      {
        "id": "res-200",
        "language": "200",
        "code": "{\n  \"id\": \"usr_abc123\",\n  \"name\": \"Jane Doe\",\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}",
        "customLabel": ""
      },
      {
        "id": "res-404",
        "language": "404",
        "code": "{\n  \"error\": \"Not found\",\n  \"message\": \"User does not exist\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "res-200"
  },
  "request": {
    "pathParameters": [
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "User ID (e.g. usr_abc123)"
      }
    ],
    "queryParameters": [
      {
        "name": "include",
        "kind": "optional",
        "type": "string",
        "description": "Comma-separated relations to include"
      }
    ],
    "headerParameters": [
      {
        "name": "Authorization",
        "kind": "required",
        "type": "string",
        "description": "Bearer token"
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "hasTryItOut": false
}
</ApiMethodV2>

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.