endpoints.json

{
  "GET /api": {
    "description": "serves up a json representation of all the available endpoints of the api"
  },
  
  
  "GET /api/topics": {
    "description": "serves an array of all topics",
    "queries": [],
    "exampleResponse": {
      "topics": [{ "slug": "football", "description": "Footie!" }]
    }
  },
  
  
  "GET /api/articles": {
    "description": "serves an array of all topics",
    "queries": ["author", "topic", "sort_by", "order"],
    "exampleResponse": {
      "articles": [
        {
          "title": "Seafood substitutions are increasing",
          "topic": "cooking",
          "author": "weegembump",
          "body": "Text from the article..",
          "created_at": "2018-05-30T15:59:13.341Z"
        }
      ]
    }
  },

   "GET /api/users/username": {
    "description": "serves an object username",
    "username": "grumpy19",
    "avatar_url": "https://www.tumbit.com/profile-image/4/original/mr-grumpy.jpg",
    "name": "Paul Grump"
  },

  "GET /api/articles/1": {
    "description": "serves an object for article id",
    "article_id": 1,
    "title": "Running a Node App",
    "body": "This is part two of a series on how to get up and running with Systemd and Node.js. This part dives deeper into how to successfully run your app with systemd long-term, and how to set it up in a production environment.",
    "votes": 0,
    "topic": "coding",
    "author": "jessjelly",
    "created_at": "2016-08-18T12:07:52.389Z",
    "comment_count": "8"
  },

  "GET /api/articles/1/comments" : {
   "description": "serves an object of comments for article id",
    
      "comment_id": 44,
      "author": "grumpy19",
      "article_id": 1,
      "votes": 4,
      "created_at": "2017-11-20T08:58:48.322Z",
      "body": "Error est qui id corrupti et quod enim accusantium minus. Deleniti quae ea magni officiis et qui suscipit non."
  }

}