https://github.com/pixelhandler/ecomapi

See Post at: http://pixelhandler.com/blog/2012/02/09/develop-a-restful-api-using-node-js-with-express-and-mongoose/
https://github.com/pixelhandler/ecomapi

Last synced: about 2 months ago
JSON representation

See Post at: http://pixelhandler.com/blog/2012/02/09/develop-a-restful-api-using-node-js-with-express-and-mongoose/

• Host: GitHub
• URL: https://github.com/pixelhandler/ecomapi
• Owner: pixelhandler
• Created: 2012-05-04T08:14:09.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-05-04T08:21:25.000Z (over 12 years ago)
• Last Synced: 2024-10-15T07:54:28.784Z (2 months ago)
• Language: JavaScript
• Homepage: http://ecomapi.herokuapp.com/#list
• Size: 354 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# Build a RESTful api using node - ecommerce example

## API for ecommerce application

### Design

* Simple API design and pragmatic REST - only 2 base URLs per resource  

* Keep verbs out of your base URLs  

* Our HTTP verbs are POST, GET, PUT, and DELETE (CRUD - Create, Read, Update, Delete)  

* Concrete names are better than abstract

Example : two resources (/products and /products/1) and the four HTTP verbs

    

        Resource

        Post
(create)

        Get
(read)

        Put
(update)

        Delete
(delete)

    

    

        /products

        create a new product

        list products

        bulk update products

        delete all products

    

    

        /products/1234

        error

        show 1234

        if exists update 1234, else error

        delete 1234

    

### Nouns

#### Products

**Product:**

    Id,  

    Title,  

    Description,  

    Image URL,  

    Categories: [ { Name } ],  

    Style Number,  

    Colors: [  

      {  

        Name,  

        Images: [  

          { Size, URL }  

        ],  

        Sizes: [  

          { Size, Available, SKU, Price }  

        ],  

      }  

    ]

**Urls:**

* /products *- list*  

* /products/:id *- single*  

### Data: MongoDB using Mongoose with Express framework running with Node.js

Models are defined by passing a Schema instance to [mongoose.model][mongoosejs model].

### References

* [API design nouns are good, verbs are bad][nouns are good verbs are bad]

* [Models are defined by passing a Schema instance to mongoose.model][mongoosejs model]

* [SchemaTypes take care of validation, casting, defaults, and other general options in our models][schema types]

* [Embedded documents are documents with schemas of their own that are part of other documents][embedded documents]

* [Backbone Todo boilerplates demonstrating integration with Node.js, Express, MongoDB][backbone boilerplates]

[nouns are good verbs are bad]: http://blog.apigee.com/detail/restful_api_design_nouns_are_good_verbs_are_bad/ "API design nouns are good, verbs are bad"

[mongoosejs model]: http://mongoosejs.com/docs/model-definition.html "Models are defined by passing a Schema instance to mongoose.model"

[schema types]: http://mongoosejs.com/docs/schematypes.html "SchemaTypes take care of validation, casting, defaults, and other general options in our models"

[embedded documents]: http://mongoosejs.com/docs/embedded-documents.html "Embedded documents are documents with schemas of their own that are part of other documents"

[backbone boilerplates]: https://github.com/addyosmani/backbone-boilerplates "Backbone Todo boilerplates demonstrating integration with Node.js, Express, MongoDB"