endpoints.json

{
  "GET /api": {
    "description": "serves up a json representation of all available endpoints of the API"
  },
  "GET /api/aliens": {
    "description": "serves an array of 24 aliens randomly selected from the aliens database",
    "queries": [],
    "exampleResponse": {
      "aliens": [
        {
          "_id": "64c82a7c28ec9bd724a3842a",
          "skinColour": "blue",
          "skinTexture": "furry",
          "eyes": 1,
          "horns": 0,
          "eyeColour": "green",
          "isFriendly": false,
          "hasAntenna": false,
          "planet": "desert",
          "__v": 0
        }
      ]
    }
  },
  "GET /api/questions": {
    "description": "serves an array of all possible questions relating to alien attributes, completing end of sentence: 'Does your alien have...'",
    "queries": [],
    "exampleResponse": {
      "questions": [
        {
          "question": "5 eyes?"
        }
      ]
    }
  },
  "GET /api/users": {
    "description": "serves an array of all users, limited to 10 per page by default and sorted by score in ascending order. User can also sort by time ascending and most recent, and can limit results to last week, month or year.",
    "queries": ["sort_by", "period", "page"],
    "exampleResponse": {
      "users": [
        {
          "id": "64d0c826c3344bff4ee84aea",
          "username": "test user",
          "score": 6,
          "time": {
            "minutes": 3,
            "seconds": 15
          },
          "created_at": "2023-08-07T10:32:06.963+00:00",
          "__v": 0
        }
      ]
    }
  },
  "POST /api/users": {
    "description": "adds a single user to the user collection and returns it. Required fields are username, score, seconds and minutes. Date is created by default.",
    "queries": [],
    "exampleResponse": {
      "user": {
        "id": "64d0c826c3344bff4ee84aea",
        "username": "test user",
        "score": 6,
        "time": {
          "minutes": 3,
          "seconds": 15
        },
        "created_at": "2023-08-07T10:32:06.963+00:00",
        "__v": 0
      }
    }
  }
}