Files
stupid-apis/doc/api.md
2025-08-28 10:31:04 +02:00

1.3 KiB
Raw Blame History

📄 API Documentation Stupid APIs

Base URL

http://localhost:3000/api

Default Headers:

Content-Type: application/json

1 POST /sort

Sorts an array (numeric or alphabetical) and returns the sorted array.

Request

URL:

POST /sort

Body Example:

{
  "array": [3, 1, 4, 1, 5, 9]
}

Successful Response

{
  "sortedArray": [1, 1, 3, 4, 5, 9]
}

2 POST /isOdd

Checks if a given number is odd.

Request

URL:

POST /isOdd

Body Example:

{
  "number": 7
}

Successful Response

{
  "ret": true
}

3 POST /isEven

Checks if a given number is even.

Request

URL:

POST /isEven

Body Example:

{
  "number": 4
}

Successful Response

{
  "ret": true
}

📌 Example Usage with curl

Sort an array (Linux/macOS)

curl -X POST http://localhost:3000/sort \
  -H "Content-Type: application/json" \
  -d '{"array":[3,1,4,1,5,9]}'

Check if odd

curl -X POST http://localhost:3000/is-odd \
  -H "Content-Type: application/json" \
  -d '{"number":7}'

Check if even

curl -X POST http://localhost:3000/is-even \
  -H "Content-Type: application/json" \
  -d '{"number":4}'