forked from FrontendMasters/api-design-node-v3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
582 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# API Design with Node V3 | ||
> Lean to build REST and GraphQL API's with node |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import controllers from '../item.controllers' | ||
import { isFunction } from 'lodash' | ||
|
||
describe('item controllers', () => { | ||
test('has crud controllers', () => { | ||
const crudMethods = [ | ||
'getOne', | ||
'getMany', | ||
'createOne', | ||
'removeOne', | ||
'updateOne' | ||
] | ||
|
||
crudMethods.forEach(name => | ||
expect(isFunction(controllers[name])).toBe(true) | ||
) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import { Item } from '../item.model' | ||
import mongoose from 'mongoose' | ||
|
||
describe('Item model', () => { | ||
describe('schema', () => { | ||
test('name', () => { | ||
const name = Item.schema.obj.name | ||
expect(name).toEqual({ | ||
type: String, | ||
required: true, | ||
trim: true, | ||
maxlength: 50 | ||
}) | ||
}) | ||
|
||
test('status', () => { | ||
const status = Item.schema.obj.status | ||
expect(status).toEqual({ | ||
type: String, | ||
required: true, | ||
enum: ['active', 'complete', 'pastdue'], | ||
default: 'active' | ||
}) | ||
}) | ||
|
||
test('notes', () => { | ||
const notes = Item.schema.obj.notes | ||
expect(notes).toEqual(String) | ||
}) | ||
|
||
test('due', () => { | ||
const due = Item.schema.obj.due | ||
expect(due).toEqual(Date) | ||
}) | ||
|
||
test('createdBy', () => { | ||
const createdBy = Item.schema.obj.createdBy | ||
expect(createdBy).toEqual({ | ||
type: mongoose.SchemaTypes.ObjectId, | ||
ref: 'user', | ||
required: true | ||
}) | ||
}) | ||
|
||
test('list', () => { | ||
const list = Item.schema.obj.list | ||
expect(list).toEqual({ | ||
type: mongoose.SchemaTypes.ObjectId, | ||
ref: 'list', | ||
required: true | ||
}) | ||
}) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import router from '../item.router' | ||
|
||
describe('item router', () => { | ||
test('has crud routes', () => { | ||
const routes = [ | ||
{ path: '/', method: 'get' }, | ||
{ path: '/:id', method: 'get' }, | ||
{ path: '/:id', method: 'delete' }, | ||
{ path: '/:id', method: 'put' }, | ||
{ path: '/', method: 'post' } | ||
] | ||
|
||
routes.forEach(route => { | ||
const match = router.stack.find( | ||
s => s.route.path === route.path && s.route.methods[route.method] | ||
) | ||
expect(match).toBeTruthy() | ||
}) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
import { crudControllers } from '../../utils/crud' | ||
import { Item } from './item.model' | ||
|
||
export default crudControllers(Item) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import mongoose from 'mongoose' | ||
|
||
const itemSchema = new mongoose.Schema( | ||
{ | ||
name: { | ||
type: String, | ||
required: true, | ||
trim: true, | ||
maxlength: 50 | ||
}, | ||
status: { | ||
type: String, | ||
required: true, | ||
enum: ['active', 'complete', 'pastdue'], | ||
default: 'active' | ||
}, | ||
notes: String, | ||
due: Date, | ||
createdBy: { | ||
type: mongoose.SchemaTypes.ObjectId, | ||
ref: 'user', | ||
required: true | ||
}, | ||
list: { | ||
type: mongoose.SchemaTypes.ObjectId, | ||
ref: 'list', | ||
required: true | ||
} | ||
}, | ||
{ timestamps: true } | ||
) | ||
|
||
itemSchema.index({ list: 1, name: 1 }, { unique: true }) | ||
|
||
export const Item = mongoose.model('item', itemSchema) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
import { Router } from 'express' | ||
import controllers from './item.controllers' | ||
|
||
const router = Router() | ||
|
||
// /api/item | ||
router | ||
.route('/') | ||
.get(controllers.getOne) | ||
.post(controllers.createOne) | ||
|
||
// /api/item/:id | ||
router | ||
.route('/:id') | ||
.get(controllers.getOne) | ||
.put(controllers.updateOne) | ||
.delete(controllers.removeOne) | ||
|
||
export default router |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
import { crudControllers } from '../../utils/crud' | ||
import { List } from './list.model' | ||
|
||
export default crudControllers(List) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import mongoose from 'mongoose' | ||
|
||
const listSchema = new mongoose.Schema( | ||
{ | ||
name: { | ||
type: String, | ||
required: true, | ||
trim: true, | ||
maxlength: 50 | ||
}, | ||
description: String, | ||
createdBy: { | ||
type: mongoose.SchemaTypes.ObjectId, | ||
ref: 'user', | ||
required: true | ||
} | ||
}, | ||
{ timestamps: true } | ||
) | ||
|
||
listSchema.index({ user: 1, name: 1 }, { unique: true }) | ||
|
||
export const List = mongoose.model('list', listSchema) |
Oops, something went wrong.