4min

API Endpoints

We also recognize that many companies are not providing standardised APIs, so we've built an in-house widget to let you describe to your team or customers how your API looks like.

It is also very useful when working together with outside teams, where you need to communicate an API specification, 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.

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

Get a cake by its ID
GET
Params
Body Parameters
required
String
ID of the cake to get
Get a cake by its ID
GET
Params
Body Parameters
required
String
ID of the cake to get

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

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

ο»Ώ

Updated 14 Apr 2022
Did this page help you?
Yes
No