Code Monkey home page Code Monkey logo

rest-api-eng-project's Introduction

API basic using.

  • api.domain.com just is a example. Run at local: localhost:PORT/v1.

User

User Schema:

firstName: { type: String },
lastName: { type: String },
email: { type: String },
decks: [{ type: Schema.Types.ObjectId, ref: "Deck" }],
  • [GET] Get all users:
api.mydomain.com/v1/users
  • [GET] Get a user:
api.mydomain.com/v1/users/:userId
  • [POST] Create a user:
api.mydomain.com/v1/users
  • [PUT] Replace a user:
api.mydomain.com/v1/users/:userId
  • [PATH] Update a user:
api.mydomain.com/v1/users/:userId

Deck

Deck Schema

name: {type: String,},
description: {type: String},
total: {type: Number, default: 0},
owner: {
    type: Schema.Types.ObjectId,
        ref: "User",
}
  • [GET] Get User's decks:
api.mydomain.com/v1/users/:userId/decks
  • [GET] Get all deck
api.mydomain.com/v1/decks
  • [GET] Get a deck
api.mydomain.com/v1/decks/:deckId
  • [POST] Create new Deck
api.mydomain.com/v1/users/:userId/decks
  • [PUT] Replace a deck
api.mydomain.com/v1/decks/:deckId
  • [PATCH] Update a deck
api.mydomain.com/v1/decks/:deckId
  • [DELETE] Delete a deck
api.mydomain.com/v1/decks/:deckId

Todo:

  • filters
  • sort
  • random
  • pagination
  • custom joi error message

rest-api-eng-project's People

Contributors

leephan2k1 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.