0.0.2 • Published 8 years ago
1api v0.0.2
1api
One way to create multiple api servers at once
Getting Started
npm install --save 1api
Make a basic file called
index.js
with the following code:
const oneApi = require('1api');
// Only a http server
const myApi = new oneApi({http: true});
// Add route
myApi.get('/welcome', (req, res) =>
{
console.log(req.apiMethod); // "HTTP" or "WS"
res.status(200).send("Welcome to this module!");
});
// create server and listen on port 3000
myApi.createServer(3000);
Start de server with
node index.js
Open
localhost:3000/welcome
in the browser and you should see:Welcome to this module!
.
Running the tests
All the tests are in the test folder and can be run with npm test
.
//TODO: Add a general test with http server and websocket server
Coding style
//TODO: Add coding style
Built With
- NodeJS (only tested on Node v6.9.5 and should work with all newer versions)
- Mocha and chai for testing
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. //TODO: Create CONTRIBUTING.md
Versions
0.0.1
- Initial commit
- Basic http- and websocket-server
Authors
- Dirk de Visser - Main author - Dirk de Visser
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details