Skip to content

matthew-andrews/offline-news-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

offline-news-api Codeship Status for matthew-andrews/offline-news-api

Simple RESTful API that allows you to get news either item by item or as an array of items.

Install and run

git clone git@github.com:matthew-andrews/offline-news-api.git
cd offline-news-api
npm install
node index.js

Documentation

GET /stories

Returns an array of story objects - see GET /stories/:guid for documentation on story objects.

curl https://offline-news-api.herokuapp.com/stories

GET /stories/:guid

Returns a story object with given guid.

curl https://offline-news-api.herokuapp.com/stories/249271
Property Type Description
guid string Unique identifier, also a URL
author string Author of the story
title string Title, usually the headline
body string Story body
date timestamp Publish date