React - Bootstrap Theme

Introduction

This is a documentation page demo for an API, you can use it for your own purposes if you want to showcase your API or some other kind of documentation for your app. The info shown here is merely for the demo so it is not real.

You can edit the code with anything you like and use only the languages that you want, the code syntax highlighting is made using highlightjs.org and supports a good variety of languages. Comes with some color schemes by default but you can easily customize the scheme of each language directly from the CSS.

# All this code is just for demonstration purposes

React.api_key = "In here goes your api key!"# All this code is just for demonstration purposes

react.api_key = "In here goes your api key!"# All this code is just for demonstration purposes

React::setApiKey("In here goes your api key!");

Authentication

It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

class A < B 
  def self.create(object = User) 
    return object 
  end

  def full_name
    return "#{self.first_name} #{self.last_name}"
  end
end
class Mapping:
  def __init__(self, iterable):
    self.items_list = []
    self.__update(iterable)

  def update(self, iterable):
    for item in iterable:
      self.items_list.append(item)
class myClass {
  var $input;
  var $output;

  function myClass($input) {
    $output = 'You entered: ' . $input;
    return $output;
  }
}

Games

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.

It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

The Game Object

name:

string The name of the game

company:

string The name of the company creator

some_key:

string

rating:

integer The rating of the game from 0 to 100.

description:

hash key/value pairs with fields that describe the game.

React::Game.create(
  :name => "Super Mario Bros",
  :company => "Nintendo",
  :some_key => "yey_JA390094AWPIWWN435",
  :rating => 100
)
react.Game.create(
  name="Super Mario Bros",
  company="Nintendo",
  some_key="yey_JA390094AWPIWWN435"
  rating=100
)
React_Charge::create(array(
  "name" => "Super Mario Bros",
  "company" => "Nintendo",
  "some_key" => "yey_JA390094AWPIWWN435"
  "rating" => 100
));

# Object Response
{
  "object": "Game",
  "name": "Super Mario Bros",
  "company": "Nintendo",
  "some_key": "yey_JA390094AWPIWWN435",
  "rating": 100
  "description": {
    "some_desc1": null,
    "some_desc2": null,
    "some_desc3": null,
    "some_desc4": null,
  }
  "valid": true,
  "other_field": null
}

Users

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.

The User Object

name:

string The name of the user

email:

string The email of the user

country:

string 2 letter code for the country

age:

integer Age of the user

description:

hash key/value pairs with fields that describe the user.

React::User.create(
  :name => "John McClane",
  :email => "[email protected]",
  :country => "US",
  :some_key => "yey_JA390094AWPIWWN435",
  :age => 53
)
react.User.create(
  name="John McClane",
  email="[email protected]",
  country="US",
  some_key="yey_JA390094AWPIWWN435",
  age=53
)
React_User::create(array(
  "name" => "John McClane",
  "email" => "[email protected]",
  "country" => "US",
  "some_key" => "yey_JA390094AWPIWWN435",
  "age" => 53
));

# Object Response
{
  "object": "User",
  "name": "John McClane",
  "email": "[email protected]",
  "country": "US",
  "some_key": "yey_JA390094AWPIWWN435",
  "age": 53
  "address": {
    "address_line1": null,
    "address_line2": null,
    "address_city": null,
    "address_state": null,
    "address_zip": null,
    "address_country": null
  }
  "valid": true,
  "description": null
}

Orders

It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

React::Order.create(
  :item => "React Bootstrap Theme",
  :price => 1500,
  :name => "John McClane",
  :email => "[email protected]",
  :country => "US",
  :some_key => "yey_JA390094AWPIWWN435",
  :age => 53
)
react.User.create(
  item="React Bootstrap Theme",
  price=1500,
  name="John McClane",
  email="[email protected]",
  country="US",
  some_key="yey_JA390094AWPIWWN435",
  age=53
)
React_User::create(array(
  "item" => "React Bootstrap Theme",
  "price" => 1500,
  "name" => "John McClane",
  "email" => "[email protected]",
  "country" => "US",
  "some_key" => "yey_JA390094AWPIWWN435",
  "age" => 53
));

# Object Response
{
  "object": "Order",
  "item": "React Bootstrap Theme",
  "price": 1500,
  "name": "John McClane",
  "email": "[email protected]",
  "country": "US",
  "some_key": "yey_JA390094AWPIWWN435",
  "age": 53
  "address": {
    "address_line1": null,
    "address_line2": null,
    "address_city": null,
    "address_state": null,
    "address_zip": null,
    "address_country": null
  }
  "valid": true,
  "description": null
}

Errors

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.

Attributes

code:

string Code of the error

message:

string A complete message with details about the error to show users.

200 OK - Everything worked.

400 Bad Request - The request was badly built

401 Unauthorized - Some other message

402 Request Failed - The request failed

404 Not Found - Doesn't exist

500, 502, 503, 504 Server errors

Spacial

Introduction

Authentication

Games

The Game Object

Users

The User Object

Orders

Errors

Attributes