index.md 1.7 KB


title: API Reference

language_tabs:

  • bash
  • javascript

includes:

search: true

toc_footers:

Welcome to the generated API reference. Get Postman Collection

#general

Example title.

This will be the long description. It can also be multiple lines long.

Example request:

curl -X GET "http://localhost/api/test" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://localhost/api/test",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/test

HEAD api/test

api/fetch

Example request:

curl -X GET "http://localhost/api/fetch" \
-H "Accept: application/json"
var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://localhost/api/fetch",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "id": 1,
    "name": "Banana",
    "color": "Red",
    "weight": "300 grams",
    "delicious": true
}

HTTP Request

GET api/fetch

HEAD api/fetch