Git Product home page Git Product logo

saveitapp's Introduction

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:

{
  "status": 200,
  "message": "Success"
}

While an error looks like:

{
  "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:

{
  "username": "myuser"
}

Returns the standard response.

GET /users/{id}

Get information about a particular user. In addition to the standard response:

{
  "id": "/users/1234"
}

GET /users/{id}/items

Get a list of items IDs for a particular user. In addition to the standard response:

{
  "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:

{
  "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:

{
  "user": {
    "id": "/users/1234"
  },
  id: "/users/1234/items/item-id-1"
}

saveitapp's People

Contributors

joshdmiller avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.