scribe/tests/Fixtures/partial_resource_index.md

---

title: API Reference

language_tabs:

• bash
• javascript

includes:

search: true

toc_footers:

• Documentation Powered by Documentarian

  Info

Welcome to the generated API reference. Get Postman Collection

#general

Display a listing of the resource.

Example request:

curl -X GET -G "http://localhost/api/users" \
    -H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://localhost/api/users",
    "method": "GET",
    "headers": {
        "accept": "application/json",
    }
}

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

Example response:

{
    "index_resource": true
}

HTTP Request

GET api/users

Show the form for creating a new resource.

Example request:

curl -X GET -G "http://localhost/api/users/create" \
    -H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://localhost/api/users/create",
    "method": "GET",
    "headers": {
        "accept": "application/json",
    }
}

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

Example response:

{
    "create_resource": true
}

HTTP Request

GET api/users/create