https://github.com/coderofsalvation/coffeerest-api-db

automatic No-SQL/SQL database ORM-mapping for coffeerest-api (Api scaffolding from a model specification in few lines of coffeescript OH MY)
https://github.com/coderofsalvation/coffeerest-api-db

Last synced: about 1 year ago
JSON representation

automatic No-SQL/SQL database ORM-mapping for coffeerest-api (Api scaffolding from a model specification in few lines of coffeescript OH MY)

• Host: GitHub
• URL: https://github.com/coderofsalvation/coffeerest-api-db
• Owner: coderofsalvation
• License: bsd-3-clause
• Created: 2015-09-13T21:41:36.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-05-28T18:45:07.000Z (about 6 years ago)
• Last Synced: 2025-02-12T06:22:36.959Z (over 1 year ago)
• Language: CoffeeScript
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
Unfancy rest apis, connect any db (redis/mysql/mongodb/etc) to coffeerest



Connect any database to coffeerest-api

## Ouch! Is it that simple?

Just add these fields to your coffeerest-api `model.coffee` specification 

    module.exports = 

      name: "project foo"

      db: 

        type: "redis"

        config:

          port: 6379

        resources:

          article:

            schema:

              taggable: true

              description: "this foo bar"

              properties:

                id:

                  type: "integer"

                title: 

                  type: "string"

                  length: 255

                  default: "title not set"

                  required: true

                  index: true

                content:

                  type: "string"

                  default: "Lorem ipsum"

                  typehint: "content"

                  required: true

                date:

                  type: "string"

                  typehint: "date"

                  default: "Date.now"

            belongsTo:

              user:      { as: 'user', foreignKey: 'user_id' }

          user:

            schema:

              taggable: true

              description: "author"

              properties:

                id:      { type: "integer", default: 123, requiretag: ["admin"] }

                email:   { type: "string", required:true, default: 'John Doe', requiretag: ["admin"] }

                apikey:  { type: "string",  required: true, default: "john@doe.com", pattern: "/\S+@\S+\.\S+/" }

            hasMany:

              article: { as: 'articles', foreignKey: 'user_id' }

      resources:

        '/book/:category':

          post:

            ...

## Usage 

    npm install coffeerest-api

    npm install coffeerest-api-db

for more info / servercode see [coffeerest-api](https://www.npmjs.com/package/coffeerest-api)

## Example 

    $ coffee server.coffee &

    registering REST resource: /v1/article (post)

    registering REST resource: /v1/article/:id (get)

    registering REST resource: /v1/article/:id (del)

    registering REST resource: /v1/article/:id (put)

    registering REST resource: /v1/article/tags (post)

    registering REST resource: /v1/article/tags/:id (get)

    registering REST resource: /v1/article/tags/:id (del)

    registering REST resource: /v1/article/tags/:id (put)

    registering REST resource: /v1/user (post)

    registering REST resource: /v1/user/:id (get)

    registering REST resource: /v1/user/:id (del)

    registering REST resource: /v1/user/:id (put)

    registering REST resource: /v1/user/tags (post)

    registering REST resource: /v1/user/tags/:id (get)

    registering REST resource: /v1/user/tags/:id (del)

    registering REST resource: /v1/user/tags/:id (put)

    $ curl -H 'Content-Type: application/json' -X POST http://localhost:$PORT/v1/article --data '{"title":"foo","content":"bar"}' 

    $ curl -H 'Content-Type: application/json' http://localhost:$PORT/v1/article/1 

    $ curl -H 'Content-Type: application/json' -X PUT http://localhost:$PORT/v1/article/1 --data '{"title":"flopje", "content":"bar"}' 

    $ curl -H 'Content-Type: application/json' http://localhost:$PORT/v1/article/1 

    $ curl -H 'Content-Type: application/json' -X DELETE http://localhost:$PORT/v1/article/1 

Voila! all api-endpoints are generated, validated and connected to a database store of your choice (using jugglingdb)!

## Tag system 

coffeerest-api-db also includes a tag/permission system.

What is that?

Well..this was inspired by roundup tracker.

It allows tagging database-objects and adding permissions to tags.

The aim is to offer extendability to a databasedesign without fiddling with code.

For example, many 'could you add this extra field in the database'-featurerequest or 'hey we need an extra category'-featurerequest could be prevented by just having tag-features. 

*need more docs here*