Package Exports

hapi-webapi

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hapi-webapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hapi-webapi

Implements an abstraction for Hapi using TypeScript, that provides a similar pattern to the ASP.NET WebApi framework for implementing Apis on Hapi.

Quickstart

To get started quickly, you can clone the 'hapi-microservice' repository (coming soon), which includes all files needed to get started with TypeScript and the hapi-webapi.

Getting started

Start by creating a package.json:

npm init

Install hapi-webapi and save it to your package.json dependencies:

npm install hapi-webapi --save

Create a server.ts file with the following contents:

import {StartOptions, WebApp} from 'hapi-webapi';
import {Startup} from './startup';

var options = new StartOptions();
options.port = 4500;

WebApp.Start<Startup>(Startup, options);

Create a startup.ts file with the following contents:

import {HttpConfiguration, IAppBuilder, IStartup} from 'hapi-webapi';
import {UsersController} from './controller';

const pgk = require('./package.json');

class Startup implements IStartup {
    Configuration(app: IAppBuilder) {
        
        var config = new HttpConfiguration();
        
        config.enableSwagger({ title: 'Directory API', description: pgk.description, version: pgk.version });
        config.enableSwaggerUi({ title: 'API Documentation v' + pgk.version, path: '/docs'  });

        // This is different from ASP.NET WebAPI, controllers needs to manually be registered.
        app.controllers.add(UsersController);
        
        app.useWelcomePage();
        app.useStaticFiles('static');
        
        app.useWebApi(config);
    }
}

Create a controller.ts file with the following contents:

import {HttpGet, HttpPost, HttpDelete, HttpPut, RoutePrefix, Route, ApiController} from '../hapi-webapi';

@RoutePrefix("users")
export class UsersController extends ApiController {
    @Route("{id}")
    @HttpGet()  // Also supports @HttpPut, @HttpPost, @HttpDelete
    getUserById(id: string) {
        
        return "getUserById:" + id;
    }
    
    @Route("list")
    @HttpGet()
    list() {
        // Examples of request object values available:
        // Url object.
        console.log(this.request.requestUri);
        
        // HTTP version.
        console.log('HTTP Version: ' + this.request.version);
        
        // HTTP headers.
        console.log(this.request.headers);
        
        return "Hello World!";
    }
}

Launch the application by running:

npm start

And open localhost:4500 or localhost:4500/docs for Swagger UI in your browser.

hapi-webapi

Package Exports

Readme

hapi-webapi

Quickstart

Getting started

License