Points de terminaison API

nous reconnaissons également que toutes les entreprises ne fournissent pas d'apis standardisées, c'est pourquoi nous avons construit un widget interne pour vous permettre de décrire à votre équipe ou à vos clients à quoi ressemble votre api de plus, c'est très utile lorsque vous travaillez avec des équipes externes, où vous devez communiquer une spécification d'api, et au lieu de fournir un fichier json, vous fournissez un document avec ce widget, et laissez le décrire tout, de l'url, des paramètres, des cookies, de la structure de la requête, de la structure de la réponse, etc vous pouvez en ajouter un en tapant (api) dans l'éditeur ou en cliquant sur l'icône api dans une nouvelle ligne { "tab" "exemples", "url" "https //api cakes com/v1/cakes/\ id", "name" "api des gâteaux", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id du gâteau à obtenir, \n gratuitement bien sûr " } ], "queryparameters" \[ { "kind" "required", "name" "recipe", "type" "string", "description" "l'api fera de son mieux pour trouver \n un gâteau correspondant à la recette fournie " }, { "kind" "required", "name" "gluten", "type" "boolean", "description" "si le gâteau doit être \n sans gluten ou non " } ], "headerparameters" \[ { "kind" "required", "name" "x auth token", "type" "string", "description" "jeton d'authentification pour suivre \n qui vide nos stocks " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "mnzw47tkmdx5vby a7w y", "code" "{\n \\"name\\" \\"nom du gâteau\\",\n \\"recipe\\" \\"nom de la recette du gâteau\\",\n \\"cake\\" \\"gâteau binaire\\"\n}", "language" "200" }, { "id" "4txta0 lo1two7fovvfjj", "code" "{\n \\"message\\" \\"il n'y a pas de gâteau comme ça \\"\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('erreur ' + 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('erreur ' + err));", "language" "ruby" } ], "selectedlanguageid" "5x2tfkoh7utdmgpv45doa" }, "responses" \[ { "statuscode" 200, "description" "gâteau récupéré avec succès ", "jsonexample" "{\n \\"name\\" \\"nom du gâteau\\",\n \\"recipe\\" \\"nom de la recette du gâteau\\",\n \\"cake\\" \\"gâteau binaire\\"\n}" }, { "statuscode" 404, "description" "impossible de trouver un gâteau correspondant à cette requête ", "jsonexample" "{\n \\"message\\" \\"il n'y a pas de gâteau comme ça \\"\n}" } ], "description" "ce point de terminaison vous permet d'obtenir des gâteaux gratuits ", "currentnewparameter" { "label" "paramètre de chemin", "value" "pathparameters" }, "hastryitout" true, "autogeneratedanchorslug" "api des gteaux", "legacyhash" "ur6ob1 8v48oci1ix7eyi" } { "tab" "examples", "url" "https //api cakes com", "name" "ajouter un gâteau", "method" "put", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id du gâteau à obtenir" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ujxlls271gishxhhb4vuq", "code" "", "language" "100" }, { "id" "yjfwqlnqqz1cqwmbdwvsv", "code" "{\n \\"name\\" \\"nom du gâteau\\",\n}", "language" "200" }, { "id" "vefstjk4uscab9yr7ak6y", "code" "{\n \\"message\\" \\"il n'y a pas de gâteau comme ça \\"\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" "un texte simple ", "language" "none" } ], "selectedlanguageid" "a7syxh465clsn6x0xbe4g" }, "description" "ajouter un nouveau gâteau", "currentnewparameter" { "label" "paramètre de corps", "value" "bodydataparameters" }, "hastryitout" true, "autogeneratedanchorslug" "ajouter un gteau", "legacyhash" "zefkbnevwtwvb6gfp8448" } c'est très flexible de laisser votre équipe décrire en détail tout type de point de terminaison http nous travaillons également à le rendre interactif, afin que vos clients puissent réellement faire la demande depuis ici trouvez d'autres blocs découvrez de nouvelles façons et blocs pour créer des pages de documentation époustouflantes et fonctionnelles docid\ y67fwv0aelfno1p2x7nmj besoin d'aide ? ⬇️ utilisez le bleu bulle de chat dans le coin inférieur droit ou essayez ai chat (à partir de la barre de recherche) pour des réponses rapides votre opinion compte utilisez le formulaire de feedback ci dessous, anonymement ou posez une question dans la section q\&a et notre équipe ou l'ia vous donnera une solution