• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

adrianObel/koa2-api-boilerplate: Boilerplate for building APIs with koa2.

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

adrianObel/koa2-api-boilerplate

开源软件地址:

https://github.com/adrianObel/koa2-api-boilerplate

开源编程语言:

JavaScript 100.0%

开源软件介绍:

#koa2-api-boilerplate js-standard-style

Boilerplate for building APIs with koa2 and mongodb.

This project covers basic necessities of most APIs.

  • Authentication (passport & jwt)
  • Database (mongoose)
  • Testing (mocha)
  • Doc generation with apidoc
  • linting using standard

##Requirements

  • node ^4.0.0
  • npm ^3.0.0

##Installation

git clone https://github.com/adrianObel/koa2-api-boilerplate.git

##Features

##Structure

├── bin
│   └── server.js            # Bootstrapping and entry point
├── config                   # Server configuration settings
│   ├── env                  # Environment specific config
│   │   ├── common.js
│   │   ├── development.js
│   │   ├── production.js
│   │   └── test.js
│   ├── index.js             # Config entrypoint - exports config according to envionrment and commons
│   └── passport.js          # Passportjs config of strategies
├── src                      # Source code
│   ├── modules
│   │   ├── controller.js    # Module-specific controllers
│   │   └── router.js        # Router definitions for module
│   ├── models               # Mongoose models
│   └── middleware           # Custom middleware
│       └── validators       # Validation middleware
└── test                     # Unit tests

##Usage

  • npm start Start server on live mode
  • npm run dev Start server on dev mode with nodemon
  • npm run docs Generate API documentation
  • npm test Run mocha tests

##Documentation API documentation is written inline and generated by apidoc.

Visit http://localhost:5000/docs/ to view docs

##License MIT




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap