API-Endpunkte

wir erkennen auch an, dass nicht alle unternehmen standardisierte apis bereitstellen daher haben wir ein eigenes widget entwickelt, mit dem sie ihrem team oder ihren kunden beschreiben können, wie ihre api aussieht außerdem ist es äußerst nützlich bei der zusammenarbeit mit externen teams, wenn sie eine api spezifikation kommunizieren müssen anstatt eine json datei bereitzustellen, geben sie ein dokument mit diesem widget aus und lassen es alles beschreiben, von url über parameter, cookies, anfrage struktur, antwort struktur usw sie können eines hinzufügen, indem sie (api) im editor eingeben oder in einer neuen zeile auf das api symbol klicken { "tab" "examples", "url" "https //api cakes com/v1/cakes/\ id", "name" "cakes api", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id of the cake to get, \n for free of course " } ], "queryparameters" \[ { "kind" "required", "name" "recipe", "type" "string", "description" "the api will do its best to find \n a cake matching the provided recipe " }, { "kind" "required", "name" "gluten", "type" "boolean", "description" "whether the cake should be \n gluten free or not " } ], "headerparameters" \[ { "kind" "required", "name" "x auth token", "type" "string", "description" "authentication token to track \n down who is emptying our stocks " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "mnzw47tkmdx5vby a7w y", "code" "{\n \\"name\\" \\"cake's name\\",\n \\"recipe\\" \\"cake's recipe name\\",\n \\"cake\\" \\"binary cake\\"\n}", "language" "200" }, { "id" "4txta0 lo1two7fovvfjj", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "language" "404" } ], "selectedlanguageid" "mnzw47tkmdx5vby a7w y" }, "examples" { "languages" \[ { "id" "5x2tfkoh7utdmgpv45doa", "code" "fetch(\\"https //api cakes com/v1/cakes/\ id\\", {\n \\"method\\" \\"post\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "javascript" }, { "id" "sdqk0bbltuvgbkzujlssv", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cakes com/v1/cakes/\ id';\nlet options = {\n method 'post', \nheaders {\n accept 'application/json',\n }\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "nodejs" }, { "id" "g4zgydloidvduj2yhzvt6", "code" "curl request post\n url https //api cakes com/v1/cakes/\ id \n header 'accept application/json'", "language" "curl" }, { "id" "s6tuvimawbitxzfw9nglm", "code" "import requests\n\nurl = \\"https //api cakes com/v1/cakes/\ id\\"\nheaders = {\\"accept\\" \\"application/json\\"}\nresponse = requests request(\\"get\\", url, headers=headers)\nprint(response text)", "language" "python" }, { "id" "awzqoyuxp7zqi qoobwaz", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cakes com/v1/cakes/\ id';\nlet options = {method 'post', headers {accept 'application/json'}};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "ruby" } ], "selectedlanguageid" "5x2tfkoh7utdmgpv45doa" }, "responses" \[ { "statuscode" 200, "description" "cake successfully retrieved ", "jsonexample" "{\n \\"name\\" \\"cake's name\\",\n \\"recipe\\" \\"cake's recipe name\\",\n \\"cake\\" \\"binary cake\\"\n}" }, { "statuscode" 404, "description" "could not find a cake matching this query ", "jsonexample" "{\n \\"message\\" \\"ain't no cake like that \\"\n}" } ], "description" "this endpoint allows you to obtain free cakes ", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "hastryitout" true, "autogeneratedanchorslug" "cakes api", "legacyhash" "ur6ob1 8v48oci1ix7eyi" } { "tab" "examples", "url" "https //api cakes com", "name" "add cake", "method" "put", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id des abzurufenden kuchens" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ujxlls271gishxhhb4vuq", "code" "", "language" "100" }, { "id" "yjfwqlnqqz1cqwmbdwvsv", "code" "{\n \\"name\\" \\"cake's name\\",\n}", "language" "200" }, { "id" "vefstjk4uscab9yr7ak6y", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "language" "404" } ], "selectedlanguageid" "ujxlls271gishxhhb4vuq" }, "examples" { "languages" \[ { "id" "a7syxh465clsn6x0xbe4g", "code" "fetch(\\"https //api cakes com\\", {\n \\"method\\" \\"get\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "javascript" }, { "id" "48wtucfgch18gcuyity h", "code" "a simple text ", "language" "none" } ], "selectedlanguageid" "a7syxh465clsn6x0xbe4g" }, "description" "einen neuen kuchen hinzufügen", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" true, "autogeneratedanchorslug" "add cake", "legacyhash" "zefkbnevwtwvb6gfp8448" } es ist sehr flexibel und ermöglicht ihrem team, jeden typ von http endpunkt im detail zu beschreiben wir arbeiten auch daran, es interaktiv zu machen, sodass ihre kunden die anfrage direkt von hier aus stellen können andere blöcke finden entdecken sie neue wege und blöcke, um beeindruckende und funktionale dokumentationsseiten zu erstellen alle blöcke ansehen docid\ qr1fjhmpreujxqqndqr1 brauchen sie hilfe? ⬇️ verwenden sie die blaue chat blase in der unteren rechten ecke oder versuchen sie ai chat (aus dem suchfeld) für schnelle antworten ihre meinung ist wichtig nutzen sie das folgende feedback formular, anonym oder stellen sie eine frage im q\&a bereich und unser team oder die ki wird ihnen eine lösung geben