https://github.com/warlock/nodejs-api-rest-tester
RxApi : Fast dummy API RESTFULL & WEBSOCKETS
https://github.com/warlock/nodejs-api-rest-tester
api database http rest restfull socketio websockets
Last synced: about 2 months ago
JSON representation
RxApi : Fast dummy API RESTFULL & WEBSOCKETS
- Host: GitHub
- URL: https://github.com/warlock/nodejs-api-rest-tester
- Owner: warlock
- Created: 2016-11-28T15:00:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-13T15:15:59.000Z (over 4 years ago)
- Last Synced: 2025-06-11T02:51:44.371Z (about 1 year ago)
- Topics: api, database, http, rest, restfull, socketio, websockets
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/rxapi
- Size: 79.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RxApi DUMMY VERSION
>Run the minimal API HTTP RESTFULL and WEBSOCKETS in memory database for make a fast dummy testing.
>
>https://rxapi.js.gl
### Install rxAPI from npm
```sh
sudo npm i rxapi -g
```
### Create a dummy project
```sh
rxapi dummy project
```
### Create a server project
```sh
rxapi new project
```
## DOCUMENTATION FOR RXAPI DUMMY IN MEMORY:
[http://rxapi.js.gl](http://rxapi.js.gl)
### Generate models schema in 'schema.json'
```json
{
"users": {
"username" : "string",
"surname" : "string",
"password" : "string"
},
"articles": {
"title" : "string",
"creation" : "date",
"tags" : "string",
"content" : "text",
"author" : "string"
}
}
```
### Generate HTTP RESTFULL scaffold in 'scaffold/http.js':
```js
module.exports = api => {
api.gen('articles')
}
```
### Generate SOCKET.IO scaffold in 'scaffold/socket.js':
```js
module.exports = api => {
api.gen('articles' (socket, db) => {
console.log('SOCKET Articles listening...')
})
}
```
### Run
```sh
npm start
```
### HTTP API RESTFULL Routes
Articles demo:
| HTTP Route | Verb | Description |
| ---------------------- |:--------:| ------------------------------:|
| /articles | GET | Get all articles |
| /articles | POST | Create a article |
| /articles/:article_id | GET | Get a single article |
| /articles/:article_id | PUT | Update a article with new info |
| /articles/:article_id | DELETE | Delete article |
### SOCKET.IO SCAFFOLD
Articles demo:
| Emit and events | Description |
| ----------------- | ------------------------------:|
| articlesGetAll | Get all articles |
| articlesAdd | Create a article |
| articlesGet | Get a single article |
| articlesUpdate | Update a article with new info |
| articlesDelete | Delete article |
### Add fast features in HTTP with callback:
```js
api.gen('users', (http, db) => {
db.loadDatabase(err => {
if (err) throw Error(`DB USER: Have a problem loading db ${err}`)
else {
db.insert({
"username" : "user",
"name" : "user_name",
"surname" : "user_surname",
"password" : "password"
},
(err, newDoc) => {
if (err) throw Error(`DB USER: Have a problem inserting in db ${err}!`);
else console.log(`DB USER: Default user created!`);
})
}
})
})
```
### Add fast features in SOCKET with callback:
```js
api.gen('articles', (socket, db) => {
db.find({ _id : FX8REOZyumD022XE }, (err, docs) => {
if (err) console.error(`Error... ${err}`)
else console.log(`Results: ${JSON.stringify(docs)}`)
})
})
```
### Dependencies thanks
- Express.js [http://expressjs.com/](http://expressjs.com)
- Socket.io [http://socket.io](http://socket.io)
- Body-parser [https://github.com/expressjs/body-parser](https://github.com/expressjs/body-parser)
- NeDB [https://github.com/louischatriot/nedb](https://github.com/louischatriot/nedb)
### License
The MIT License (MIT) Copyright (c) 2016 Josep Subils Rigau (josep@js.gl)
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.