Puntos finales de la API

también reconocemos que no todas las empresas proporcionan apis estandarizadas, por lo que construimos un widget interno para permitirte describir a tu equipo o clientes cómo es tu api además, es muy útil cuando se trabaja junto con equipos externos, donde necesitas comunicar una especificación de api, y en lugar de proporcionar un archivo json, proporcionas un documento con este widget, y dejas que describa cualquier cosa desde url, parámetros, cookies, estructura de solicitud, estructura de respuesta, etc puedes agregar uno escribiendo (api) en el editor o haciendo clic en el ícono de api en una nueva fila { "tab" "examples", "url" "https //api cakes com/v1/cakes/\ id", "name" "api de pasteles", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id del pastel a obtener, \n por supuesto, gratis " } ], "queryparameters" \[ { "kind" "required", "name" "recipe", "type" "string", "description" "la api hará su mejor esfuerzo para encontrar \n un pastel que coincida con la receta proporcionada " }, { "kind" "required", "name" "gluten", "type" "boolean", "description" "si el pastel debe ser \n sin gluten o no " } ], "headerparameters" \[ { "kind" "required", "name" "x auth token", "type" "string", "description" "token de autenticación para rastrear \n quién está vaciando nuestros stocks " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "mnzw47tkmdx5vby a7w y", "code" "{\n \\"name\\" \\"nombre del pastel\\",\n \\"recipe\\" \\"nombre de la receta del pastel\\",\n \\"cake\\" \\"pastel binario\\"\n}", "language" "200" }, { "id" "4txta0 lo1two7fovvfjj", "code" "{\n \\"message\\" \\"no hay pastel como ese \\"\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" "pastel recuperado con éxito ", "jsonexample" "{\n \\"name\\" \\"nombre del pastel\\",\n \\"recipe\\" \\"nombre de la receta del pastel\\",\n \\"cake\\" \\"pastel binario\\"\n}" }, { "statuscode" 404, "description" "no se pudo encontrar un pastel que coincida con esta consulta ", "jsonexample" "{\n \\"message\\" \\"no hay pastel como ese \\"\n}" } ], "description" "este endpoint te permite obtener pasteles gratis ", "currentnewparameter" { "label" "parámetro de ruta", "value" "pathparameters" }, "hastryitout" true, "autogeneratedanchorslug" "api de pasteles", "legacyhash" "ur6ob1 8v48oci1ix7eyi" } { "tab" "examples", "url" "https //api cakes com", "name" "agregar pastel", "method" "put", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id del pastel a obtener" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ujxlls271gishxhhb4vuq", "code" "", "language" "100" }, { "id" "yjfwqlnqqz1cqwmbdwvsv", "code" "{\n \\"name\\" \\"nombre del pastel\\",\n}", "language" "200" }, { "id" "vefstjk4uscab9yr7ak6y", "code" "{\n \\"message\\" \\"no hay pastel como ese \\"\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 texto simple ", "language" "none" } ], "selectedlanguageid" "a7syxh465clsn6x0xbe4g" }, "description" "agregar un nuevo pastel", "currentnewparameter" { "label" "parámetro del cuerpo", "value" "bodydataparameters" }, "hastryitout" true, "autogeneratedanchorslug" "agregar pastel", "legacyhash" "zefkbnevwtwvb6gfp8448" } es muy flexible permitir que tu equipo describa en detalle cualquier tipo de punto final http también estamos trabajando en hacerlo interactivo, para que tus clientes puedan hacer la solicitud desde aquí encuentra otros bloques descubre nuevas formas y bloques para crear páginas de documentación impresionantes y funcionales docid\ j rf2bopwdceioskmtfyg ¿necesitas ayuda? ⬇️ usa el burbuja de chat azul desde la esquina inferior derecha o prueba ai chat (desde el cuadro de búsqueda) para respuestas rápidas tu opinión importa usa el formulario de retroalimentación a continuación, de forma anónima o haz una pregunta en sección de preguntas y respuestas y nuestro equipo o ia te dará una solución