API‑Endpunkt

api endpunkt docid\ bg8vvtyxk7uvcjdaopows blöcke rendern interaktive api dokumentation, einschließlich anforderungsparametern, codebeispielen und antwortbeispielen syntax sie können diese komponente entweder mit markdown oder mdx syntax hinzufügen \ apimethodv2 (json configuration with name, method, url, request, examples, results) \ \<apimethodv2> (json configuration with name, method, url, request, examples, results) \</apimethodv2> die json konfiguration unterstützt die folgenden parametergruppen pfadparameter queryparameters header parameter bodydataparameters formdataparameters sie können auch anforderungsbeispiele und antwortbeispiele in mehreren sprachen einbinden wenn sie in einem zweispaltigen layout verwendet werden, werden api endpunktblöcke in der rechten spalte gerendert mdx beispiel das folgende beispiel erstellt einen endpunkt zum abrufen eines benutzers, einschließlich anforderungsparametern, mehreren codebeispielen und antwortbeispielen \<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\\" \\"jane\@example com\\",\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>