https://github.com/tyrw/dummyapi

A simple JSON API with dummy User and Item paths that give random data on command, rate-limited to 60 requests per minute.
https://github.com/tyrw/dummyapi

api api-server dummy-data

Last synced: 7 days ago
JSON representation

A simple JSON API with dummy User and Item paths that give random data on command, rate-limited to 60 requests per minute.

• Host: GitHub
• URL: https://github.com/tyrw/dummyapi
• Owner: tyrw
• License: mit
• Created: 2014-03-24T06:45:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-02-01T21:31:43.000Z (almost 8 years ago)
• Last Synced: 2023-03-24T08:46:12.810Z (over 1 year ago)
• Topics: api, api-server, dummy-data
• Language: Ruby
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
A simple JSON API with dummy User and Item paths that give random data on command, rate-limited to 60 requests per minute.  Use this site as your dummy API, or clone and modify for your own purposes.

Repo at http://github.com/tyrw/dummyapi

Demo API at http://dummyapi.herokuapp.com

> Note: the api_key parameter must be set to 123456789 for each request or you will receive an error.

**Users List**

Returns a list of 20 random Users with the following parameters:

`:id`, `:name`, `:username`, `:email`, `:created_at`, `:company: {

:name, :tagline, :description }`

    /api/v1/users

**Items List**

Returns a list of 20 random Items with the following parameters:

`:id`, `:title`, `:category`, `:color`, `:code`, `:user_id`, `:created_at`

    /api/v1/items

Also accepts the options `limit` and `user_id`, which will limit the number of items returned (max: 50) and set the `user_id`, respectively.

    /api/v1/items?limit=5

    /api/v1/items?user_id=123

**Items Show**

Returns an Item with the following parameters:

`:id` (set to number in path), `:title`, `:category`, `:color`, `:code`, `:user_id`, `:created_at`

    /api/v1/items/456

    

Also accepts the `user_id` option, which will set the user_id

    /api/v1/items/456?user_id=123