Points de terminaison API

4 min

We also recognize that not all companies provide standardized APIs, so we built an in-house widget to let you describe to your team or customers what your API looks like.

Additionally, it's super useful when working together with external teams, where you need to communicate an API specification, and instead of providing a JSON file, you provide a document with this widget, and let it describe anything from URL, Parameters, Cookies, Request structure, Response structure, etc.

You can add one by typing (api) in the editor or clicking the API icon in a new row.

Cakes API

This endpoint allows you to obtain free cakes.

POST

https://api.cakes.com/v1/cakes/:id

Path Parameters

idstringrequired
Description
ID of the cake to get, for free of course.

Query Parameters

recipestringrequired
Description
The API will do its best to find a cake matching the provided recipe.
glutenbooleanrequired
Description
Whether the cake should be gluten-free or not.

Header Parameters

X-Auth-Tokenstringrequired
Description
Authentication token to track down who is emptying our stocks.

javascript

fetch("https://api.cakes.com/v1/cakes/:id", {
  "method": "POST",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

nodejs

const fetch = require('node-fetch');

let url = 'https://api.cakes.com/v1/cakes/:id';
let options = {
  method: 'POST', 
headers: {
    Accept: 'application/json',
  }
};
fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

curl

curl --request POST
  --url https://api.cakes.com/v1/cakes/:id 
  --header 'Accept: application/json'

python

import requests

url = "https://api.cakes.com/v1/cakes/:id"
headers = {"Accept": "application/json"}
response = requests.request("GET", url, headers=headers)
print(response.text)

ruby

const fetch = require('node-fetch');

let url = 'https://api.cakes.com/v1/cakes/:id';
let options = {method: 'POST', headers: {Accept: 'application/json'}};
fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

200

{
    "name": "Cake's name",
    "recipe": "Cake's recipe name",
    "cake": "Binary cake"
}

404

{
    "message": "Ain't no cake like that."
}

Add Cake

Add a new cake

PUT

https://api.cakes.com

Body Parameters

idstringrequired
Description
ID of the cake to get

javascript

fetch("https://api.cakes.com", {
  "method": "GET",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

none

A simple text.

100

200

{
    "name": "Cake's name",
}

404

{
    "message": "Ain't no cake like that."
}

It's VERY flexible letting your team describe in detail any type of HTTP endpoint.

We're also working on making it interactive, so your customers can actually make the request from here.

Trouver d'autres blocs

Discover new ways and blocks to create stunning and functional documentation pages.

Découvrez tous les blocs

Besoin d'aide ? ⬇️

Use the bleu bulle de discussionfrom bottom right corner.

Or try Chat IA (from search box) for quick answers.

Votre avis compte

Use the below feedback form, anonymously.

Or ask a question in section Questions-Réponses and our team or AI will give you a solution.

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.