Code Monkey home page Code Monkey logo

manner-folder's Introduction

Manner-folder

Build Status NPM Downloads guidelines

Create manner resource tree from folder structure.

Usage

Create web API from a folder called v1

const manner = require('manner')
const folder = require('manner-folder')


/**
 * Generate resource tree and pass it to manner.
 */

const api = manner(folder(__dirname + '/v1'))


/**
 * Serve API through HTTP.
 */

http.createServer((req, res) => {
  api(req).pipe(res)
}).listen(4000)

Check out our examples for more usage examples.

Installation

npm install manner-folder --save

NPM

Question

For support, bug reports and or feature requests please make sure to read our community guidelines and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

Contribution

The open source community is very important to us. If you want to participate to this repository, please make sure to read our guidelines before making any pull request. If you have any related project, please let everyone know in our wiki.

License

The MIT License (MIT)

Copyright (c) 2017 Tether Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

manner-folder's People

Contributors

bredele avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

joeyhops

manner-folder's Issues

Create endpoint only if index.js exists

The index.js file should indicate the existence of an API endpoint. If the file does not exits, the module should not trigger an eception but just a warning.

Schema and params

Right now, schema are only apply for data...could we also apply schema for params?

Complex routes

We should be able to define complex routes.

service({
  '/search/:entity' : require('./search')
})

May be we could mixin params and queries. Because /search/:entity could be written as following /search?entity=foo.

Should we write a resolver module?

path inception

{
  '/': {
    '/api': '',
   '/doc': ''
  }
}

Would allow to define routes with custom behaviour (such as authorization).

Custom HTTP methods

We could combine params to call custom methods:

params: name + password
method: login (post + something else)

Catch errors correctly

All errors are caught when only http one should be. It makes developing difficult because we can not see the errors that are thrown.

Alias

Should accept aliases

{
  '/super' : '/api'
}

Service/schema console generator

We could automatically generate a console from a service + schema file to test the service. We could get documentation as well.

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.