Getting started with hiroki

This guide provides step-by-step instructions for constructing your initial REST API with Hiroki. Please note that certain aspects of this tutorial may not adhere to best practices, but they have been simplified to make the example easier to understand.

Setup

First we must create a project folder.

mkdir hello-hiroki
cd hello-hiroki

Now we have to create a package.json file.

npm init -y

Install dependencies.

npm i --save express mongoose body-parser hiroki

Project folders

Create a model folder.

mkdir models

in this folder we have to create our models.

Create the first model

create a model file (models/book.js) in models folder.

models/book.js

const mongoose = require('mongoose');

const Book = new mongoose.Schema({
  title: String,
  description: String
});

module.exports = mongoose.model('Book', Book);

Create a index file for models.

models/index.js

const Book = require('./book');

module.exports = {
  Book
}

The server file

Create a file app.js.

step by step:

Import dependencies:

const express = require('express');
const mongoose = require('mongoose');
const models = require('./models');
const bodyParser = require('body-parser');
const hiroki = require('hiroki');

Create the express app and use body-parser.

const app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: false}));

Connect to mongo:

mongoose.connect('mongodb://localhost:27017/test')
  .then(()=>{
    console.log('connection succes!');
  })

Build the rest api:

hiroki.importModels(models)

Handle errors:

app.use(function(req, res, next) {
    let err = new Error('Not Found');
    err.status = 404;
    next(err);
});
app.use('/api/*', async(req, res) => {
    const path = req.originalUrl;
    const resp = await hiroki.process(path, {
        method: req.method,
        body: req.body
    });
    res.status(resp.status || 200).json(resp);
});

The end: add the app listen

app.listen(3030);
console.log('server listening on port 3030...');

File app.js:

This is the complete file.

const express = require('express');
const mongoose = require('mongoose');
const models = require('./models');
const bodyParser = require('body-parser');
const hiroki = require('hiroki');
const app = express();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: false}));

mongoose.connect('mongodb://localhost:27017/test')
  .then(()=>{
    console.log('connection succes!');
  });

hiroki.importModels(models);

app.use(function(req, res, next) {
    let err = new Error('Not Found');
    err.status = 404;
    next(err);
});

app.use('/api/*', async(req, res) => {
    const path = req.originalUrl;
    const resp = await hiroki.process(path, {
        method: req.method,
        body: req.body
    });
    res.status(resp.status || 200).json(resp);
});


app.listen(3030);
console.log('server listening on port 3030...');

Start application

node app.js

now you can open http://localhost:3030/api/books.

have fun!

Remember:

GET: get documents.
POST: create one document.
PUT: update one document.
DELETE: remove one document.

Source code:

HERE