Discover the API

GET

const url = 'http://127.0.0.1:8000/';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:8000/

Return a welcome message and the canonical developer documentation URL.

Responses

200

Successful Response

application/json

RootResponse

API welcome message.

object

message

required

Message

Short API welcome message with a link to the documentation.

string

Example^generated

{
  "message": "example"
}

500

Unexpected server error.

application/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

detail

required

Any of:

string
Array<object>

string

Example^generated

{
  "detail": [
    {}
  ]
}

Discover the API

Responses

200

Examplegenerated

500

Examplegenerated

Example^generated

Example^generated