Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshdmiller/saveitapp
A web service to save articles for later retrieval.
https://github.com/joshdmiller/saveitapp
Last synced: 13 days ago
JSON representation
A web service to save articles for later retrieval.
- Host: GitHub
- URL: https://github.com/joshdmiller/saveitapp
- Owner: joshdmiller
- Created: 2012-11-25T00:20:07.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2012-11-27T04:31:45.000Z (almost 12 years ago)
- Last Synced: 2024-04-14T23:26:38.108Z (7 months ago)
- Language: Scala
- Size: 137 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
saveitapp
=========
A web service to save articles for later retrieval.
API Specification
=================
Introduction
------------
In addition to the requested information, a "status" integer and a "message"
string will are returned to provide information on the success of the request.
For example, a successful message will include:
```javascript
{
"status": 200,
"message": "Success"
}
```
While an error looks like:
```javascript
{
"status": 404,
"message": "The user [/users/1234] could not be found."
}
```
POST /users
-----------
Create a new user. The content type of the body must be JSON and it must include
a username:
```javascript
{
"username": "myuser"
}
```
Returns the standard response.
GET /users/{id}
---------------
Get information about a particular user. In addition to the standard response:
```javascript
{
"id": "/users/1234"
}
```
GET /users/{id}/items
---------------------
Get a list of items IDs for a particular user. In addition to the standard
response:
```javascript
{
"user": {
"id": "/users/1234"
},
"items": [
"/users/1234/items/item-id-1",
"/users/1234/items/item-id-2",
"/users/1234/items/item-id-3"
]
}
```
POST /users/{username}/items
----------------------------
Create a new item for a user. The content type of the body must be JSON and it
must include a title:
```javascript
{
"title": "this is a note title"
}
```
Returns the standard response.
GET /users/{user_id}/items/{item_id}
------------------------------------
Get a particular item. In addition to the standard response:
```javascript
{
"user": {
"id": "/users/1234"
},
id: "/users/1234/items/item-id-1"
}
```