Initial commit

This commit is contained in:
Drasko DRASKOVIC 2015-07-06 22:32:02 +02:00
commit 7d5b901dc9
5 changed files with 446 additions and 0 deletions

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
node_modules

10
app/models/thing.js Normal file
View File

@ -0,0 +1,10 @@
// app/models/thing.js
var mongoose = require('mongoose');
var Schema = mongoose.Schema;
var ThingSchema = new Schema({
name: String
});
module.exports = mongoose.model('Thing', ThingSchema);

9
package.json Normal file
View File

@ -0,0 +1,9 @@
{
"name": "node-api",
"main": "server.js",
"dependencies": {
"express": "~4.0.0",
"mongoose": "~3.6.13",
"body-parser": "~1.0.1"
}
}

132
server.js Normal file
View File

@ -0,0 +1,132 @@
// server.js
// BASE SETUP
// =============================================================================
// call the packages we need
var express = require('express'); // call express
var app = express(); // define our app using express
var bodyParser = require('body-parser');
// MongoDB
var mongoose = require('mongoose');
mongoose.connect('mongodb://localhost:27017/mainflux'); // connect to our database
var Thing = require('./app/models/thing');
// configure app to use bodyParser()
// this will let us get the data from a POST
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
var port = process.env.PORT || 8080; // set our port
// ROUTES FOR OUR API
// =============================================================================
var router = express.Router(); // get an instance of the express Router
// on routes that end in /things
// ----------------------------------------------------
router.route('/things')
// create a things (accessed at POST http://localhost:8080/api/things)
.post(function(req, res) {
var thing = new Thing(); // create a new instance of the Bear model
thing.name = req.body.name; // set the thing's name (comes from the request)
// save the thing and check for errors
thing.save(function(err) {
if (err)
res.send(err);
res.json({ message: 'Thing created!' });
});
})
// get all the things (accessed at GET http://localhost:8080/api/things)
.get(function(req, res) {
Thing.find(function(err, things) {
if (err)
res.send(err);
res.json(things);
});
});
// on routes that end in /things/:thing_id
// ----------------------------------------------------
router.route('/things/:thing_id')
// get the thing with that id (accessed at GET http://localhost:8080/api/things/:thing_id)
.get(function(req, res) {
Thing.findById(req.params.thing_id, function(err, thing) {
if (err)
res.send(err);
res.json(thing);
});
})
// update the thing with this id (accessed at PUT http://localhost:8080/api/things/:thing_id)
.put(function(req, res) {
// use our thing model to find the thing we want
Thing.findById(req.params.thing_id, function(err, thing) {
if (err)
res.send(err);
thing.name = req.body.name; // update the things info
// save the thing
thing.save(function(err) {
if (err)
res.send(err);
res.json({ message: 'Thing updated!' });
});
})
})
// delete the thing with this id (accessed at DELETE http://localhost:8080/api/things/:thing_id)
.delete(function(req, res) {
Thing.remove({
_id: req.params.thing_id
}, function(err, thing) {
if (err)
res.send(err);
res.json({ message: 'Successfully deleted' });
});
});
// middleware to use for all requests
router.use(function(req, res, next) {
// do logging
console.log('Something is happening.');
next(); // make sure we go to the next routes and don't stop here
});
// test route to make sure everything is working (accessed at GET http://localhost:8080/api)
router.get('/', function(req, res) {
res.json({ message: 'hooray! welcome to our api!' });
});
// more routes for our API will happen here
// REGISTER OUR ROUTES -------------------------------
// all of our routes will be prefixed with /api
app.use('/api', router);
// START THE SERVER
// =============================================================================
app.listen(port);
console.log('Magic happens on port ' + port);

293
swagger.yaml Normal file
View File

@ -0,0 +1,293 @@
swagger: '2.0'
# Document metadata
info:
version: "0.0.1"
title: Mainflux
termsOfService: http://swagger.io/terms/
contact:
name: API Support
url: http://wwww.mainflux.com/support
email: support@mainflux.com
license:
name: MIT
url: http://opensource.org/licenses/MIT
paths:
/status:
# This is a HTTP operation
get:
# Describe this verb here. Note: you can use markdown
description: |
Gets Mainflux server status.
# Expected responses for this operation:
responses:
# Response code
200:
description: Server is running
# A schema describing your response object.
# Use JSON Schema format
schema:
title: Status
type: string
/things:
# This is a HTTP operation
get:
# Describe this verb here. Note: you can use markdown
description: |
Gets all of the existing `Thing` objects.
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
-
name: authUuid
in: query
description: authentification UUID
required: true
type: string
-
name: authToken
in: query
description: authentification token
required: true
type: number
format: double
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: ArrayOfThings
type: array
items:
title: Thing
type: object
properties:
uuid:
type: number
name:
type: string
type:
type: string
manufacturer:
type: string
post:
# Describe this verb here. Note: you can use markdown
description: |
Creates `Thing` object.
Returns newly created Thing object.
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
-
name: authUuid
in: query
description: authentification UUID
required: true
type: string
-
name: authToken
in: query
description: authentification token
required: true
type: number
format: double
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: Thing
type: object
properties:
uuid:
type: number
name:
type: string
type:
type: string
manufacturer:
type: string
/things/{thingUuid}:
# This is a HTTP operation
get:
# Describe this verb here. Note: you can use markdown
description: |
Gets Thing object from the database by thingUuid.
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
-
name: thingUuid
in: path
description: thing UUID
required: true
type: string
-
name: authUuid
in: query
description: authentification UUID
required: true
type: string
-
name: authToken
in: query
description: authentification token
required: true
type: number
format: double
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: Thing
type: object
properties:
uuid:
type: number
name:
type: string
type:
type: string
manufacturer:
type: string
put:
# Describe this verb here. Note: you can use markdown
description: |
Updates Thing object from the database.
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
-
name: thingUuid
in: path
description: thing UUID
required: true
type: string
-
name: params
in: query
description: thing parameters
required: true
type: string
-
name: authUuid
in: query
description: authentification UUID
required: true
type: string
-
name: authToken
in: query
description: authentification token
required: true
type: number
format: double
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: Thing
type: object
properties:
uuid:
type: number
name:
type: string
type:
type: string
manufacturer:
type: string
delete:
# Describe this verb here. Note: you can use markdown
description: |
Deletes Thing object from the database.
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
-
name: thingUuid
in: path
description: thing UUID
required: true
type: string
-
name: authUuid
in: query
description: authentification UUID
required: true
type: string
-
name: authToken
in: query
description: authentification token
required: true
type: number
format: double
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: Thing
type: object
properties:
uuid:
type: number
name:
type: string
type:
type: string
manufacturer:
type: string