JSAX-RS

JavaScript API for RESTful Web Services (JSAX-RS) is a JavaScript programming language API that provides support in creating web services according to the REST architectural pattern.

Requirements

JSAX-RS needs the following system parameters in order to work correctly:

• npm 3+
• TypeScript 3+

Installation

Set up the JSAX-RS module with:

$ npm install jsax-rs --save

Documentation

JASX-RS Reference

The full JASX-RS documentation is located in the docs/jasx-rs-reference repository.

Using Components

All JSAX-RS components have to be imported with the ES6 syntax:

import { HttpStatusCode } from 'jsax-rs';

public find(id: string, res: Response): void {
  this.searchService.find(id).subscribe((result: User) => {
    if (result) {
      res.send(result);
    } else {
      res.sendStatus(HttpStatusCode.NOT_FOUND);
    }
  });
}

For a complete list of available components, please refer to the API Reference documentation.

API Reference

The API Reference documentation is not included into the JSAX-RS. To build the API reference documentation, use:

$ grunt doc

Documentation will be generated in the docs/api-reference repository.

The documentation generator is TypeDoc

Running Tests

To execute all unit tests, use:

$ grunt test

License

This JSAX-RS Project is licensed under MIT. Full license text is available in LICENSE.

MIT License

Copyright (c) 2019 Pascal ECHEMANN

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.