EDITOR
...
Editor Blocks
API docs blocks
API endpoints
3min
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 outside 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.
This endpoint allows you to obtain free cakes.
POST
Request
Path Params
id
required
String
ID of the cake to get,
for free of course.
Query Parameters
recipe
required
String
The API will do its best to find
a cake matching the provided recipe.
gluten
required
String
Whether the cake should be
gluten-free or not.
Header Parameters
X-Auth-Token
required
String
Authentication token to track
down who is emptying our stocks.
Add a new cake
PUT
Request
Body Parameters
id
required
String
ID of the cake to get
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.
🤔
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.
Updated 09 Aug 2024
Did this page help you?