ApiZilla – Examples

Docs: Sample REST endpoint

Thu, 05 Jan 2017 00:00:00 +0000

Lets create GET /products api endpoint with pagination. Products are stored in mysql or postgres database

Database structure for products table

create table product
(
 id int auto_increment
 primary key,
 name varchar(300) not null,
 price int default 0 not null,
 available tinyint(1) null,
 image varchar(300) null,
 available_quantity int default 0 not null
)
 charset = utf8mb3;

Create file ./rest/products.json

{
 "path": "/products",
 "methods": [
 "GET"
 ],
 "query": "products-paginated",
 "authorized": false
}

Create file ./queries/products-paginated.json

{
 "type": "sql-select-paginated",
 "id": "products-paginated",
 "connection": "sample-database-connection",
 "query": "SELECT * FROM `product` limit :offset, :limit",
 "queryCount": "SELECT count(*) as c FROM `product`",
 "params": [
 {
 "name": "limit",
 "type": "int",
 "default": 10,
 "required": true
 },
 {
 "name": "page",
 "type": "int",
 "default": 1,
 "required": true
 }
 ]
}

Two files later you are able to fetch your paginated products by calling endpoint below

GET http://localhost:8080/products?page=1&limit=10

{
 "results": [
 {
 "available": 1,
 "available_quantity": 10,
 "id": 1,
 "image": "/images/shoes.jpng",
 "name": "Shoes",
 "price": 10000
 },
 {
 "available": 1,
 "available_quantity": 2,
 "id": 2,
 "image": "/images/t-shirt.jpng",
 "name": "T-Shirt",
 "price": 1000
 }
 ],
 "count": 2,
 "pages": 1,
 "page": 1
}

Response lime for localhost is approximately 3ms

Docs: Database transaction

Thu, 05 Jan 2017 00:00:00 +0000

Lets insert order with items as a single database transaction

Database structure for products table

create table `order`
(
 id varchar(40) charset utf8mb3 not null
 primary key,
 amount int not null,
 user_id int not null,
 status enum ('new', 'paid', 'returned') default 'new' not null,
 created_at timestamp default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP,
 constraint order_user_id_fk
 foreign key (user_id) references user (id)
);

create table order_item
(
 id int auto_increment
 primary key,
 order_id varchar(40) not null,
 product_id int not null,
 quantity int default 0 not null,
 constraint order_item__product_fk
 foreign key (product_id) references product (id),
 constraint order_item_order_id_fk
 foreign key (order_id) references `order` (id)
)
 charset = utf8mb3;

Create file ./rest/order-new.json

{
 "path": "/api/orders",
 "methods": [
 "POST"
 ],
 "query": "order-new",
 "authorized": true
}

Create file ./queries/order-new-js.json

{
 "type": "javascript",
 "id": "order-new",
 "file": "order-new.js",
 "public": true,
 "params": []
}

Create file ./js/order-new.js

let orderId = uuid(),
 currentTransaction = transaction("sample-database-connection"),
 orderData = null;

try {
 orderData = currentTransaction.run("orders-insert", {
 "id": orderId,
 "amount": totalPrice,
 "currentUserId": 1,
 }).Data

 currentTransaction.run("order-item-insert", {
 "orderId": orderData.id,
 "productId": 1,
 "quantity": 1
 })

 currentTransaction.run("order-item-insert", {
 "orderId": orderData.id,
 "productId": 2,
 "quantity": 22
 })

 currentTransaction.commit()
} catch (e) {
 currentTransaction.rollback()
 throw {"error": e}
}

setStatusCode(200)
setResult({
 orderId: orderData.id
})

POST http://localhost:8080/api/orders

{
 "orderId": "01ce6540-cdbf-43c7-8def-3abc45147e3b"
}

You could improve logic by sending extra parameters like product ids or perform more any complex business logic

Docs: Queues

Thu, 05 Jan 2017 00:00:00 +0000

Push new message to RabbitMq via rest endpoint POST /api/analytics

Create file ./rest/analytics.json

{
 "path": "/api/analytics",
 "methods": [
 "POST"
 ],
 "query": "analytics-push",
 "authorized": false
}

Create file ./queries/analytics-push.json

{
 "type": "rabbit-publish",
 "id": "analytics-push",
 "connection": "sample-rabbit-connection",
 "queue": "analytics",
 "exchange": "",
 "body": {
 "productId": ":productId",
 "campaign": ":campaign",
 "campaignProduct": ":productId - :campaign"
 },
 "headers": {
 "testHeaderId": 1234,
 "productId": ":productId"
 },
 "params": [
 {
 "name": "productId",
 "required": true
 },
 {
 "name": "campaign",
 "required": true
 }
 ]
}

POST http://localhost:8080/api/analytics with body

{
 "productId": "1234",
 "campaign": "winter"
}

You will end up with this message on rabbitMq