Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mseemann/js-restful
Create a RESTful service with ES7 decorators for your node.js application.
https://github.com/mseemann/js-restful
Last synced: 2 months ago
JSON representation
Create a RESTful service with ES7 decorators for your node.js application.
- Host: GitHub
- URL: https://github.com/mseemann/js-restful
- Owner: mseemann
- License: mit
- Created: 2016-04-28T14:30:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-15T11:41:20.000Z (about 7 years ago)
- Last Synced: 2024-10-12T08:18:48.571Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 146 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-restful
Create a RESTful service with ES7 decorators for your node.js application.
[](https://travis-ci.org/mseemann/js-restful)
[](http://badge.fury.io/js/js-restful)
[](https://coveralls.io/github/mseemann/js-restful?branch=master)
[](https://codeclimate.com/github/mseemann/js-restful)
[](https://codeclimate.com/github/mseemann/js-restful)
[](https://codeclimate.com/github/mseemann/js-restful/coverage)
[](http://issuestats.com/github/mseemann/js-restful)
**Installation**
```bash
npm install js-restful --save
```
Make sure you have a shim for es7 reflect. For example core-js or reflect-metadat.
**Usage**
Extend your node js service class with decorators (this is TypeScript with decorators!):
```typescript
import { GET, POST, PUT, DELETE, Path, PathParam, HeaderParam, QueryParam } from 'js-restful';
class Book {
id:number;
name: string;
}
@Path('/books')
class BookService {
@GET()
allBooks() : Book[]{
return [];
}
@Path('/:name')
@POST()
createBook(@PathParam('name') name:string, @HeaderParam('token') token:string) :Book {
return {id:1, name:name};
}
@Path('/:id/:name')
@PUT()
updateBook(@PathParam('id') id:number, @PathParam('name') name:string) : Book {
return {id:id, name:name};
}
@Path('/:id')
@DELETE()
deleteBook(@PathParam('id') id:number, @QueryParam('time') time:number): boolean {
return true;
}
}
```
Later (at runtime) you can use the parser to get back all of these information:
```typescript
import { ServiceDescription, ServiceParser } from 'js-restful';
let serviceDescription = ServiceParser.parse(bookService);
```
The result is a complete description of your Service:
```json
{
"basePath":"/books",
"methods":[
{
"methodName":"allBooks",
"httpMethod":0,
"path":null,
"pathParams":[],
"headerParams":[],
"queryParams":[]
},
{
"methodName":"createBook",
"httpMethod":1,
"path":"/:name",
"pathParams":[{"paramName":"name","index":0}],
"headerParams":[{"paramName":"token","index":1}],
"queryParams":[]
},
{
"methodName":"updateBook",
"httpMethod":2,
"path":"/:id/:name",
"pathParams":[{"paramName":"name","index":1},{"paramName":"id","index":0}],
"headerParams":[],
"queryParams":[]
},
{
"methodName":"deleteBook",
"httpMethod":3,
"path":"/:id",
"pathParams":[{"paramName":"id","index":0}],
"headerParams":[],
"queryParams":[{"paramName":"time","index":1}]
}
]
}
```
Ok! But what can I do with this? Have a look at the github project [js-restful-express](https://github.com/mseemann/js-restful-express).
This is a base project that different implementations can use to integrate this information in a concrete node js framework.