ting.js

2.0.3 • Public • Published

ting.js for 2.0.3

你可以用它,工程化你的项目。使项目变得更可靠

nodejs版本: (express)node >= 7.10.0 ; (koa)node >=7.10.0

简化的较繁杂router操作,使nodejs的server端API变得更加友好。可以实时生成路由文档,使api请求一目了然,简洁代码的同时保持了主框架功能。

三特性

1.简化express的路由

2.使用es6的class语法接受请求,使工程更易于移植

3.配置即文档,根据package的版本生成文档

使用教程

步骤

开始之前

在一切开始之前,你需要具备express知识,另外,需要生成一份package.json。
准备就绪后,就开始吧!

Step 1: 下载express

你需要先下载express:
项目目录打开命令行运行 npm install express --save

Step 2: 下载ting.js

你需要先下载express:
项目目录打开命令行运行 npm install ting.js --save

Step 3: 创建index.js

入口文件


		const path = require("path");
		//引入express
		const express = require("express");
		//express_app
		var app = express();
		var ting = require("ting.js");
		//定义routes
		var routes = require("./routes");
		//引入_package
		var _package = require("./package.json");
		//初始化
		var ting_fn = function(init){
			init(routes);
		}
		//生成路由
		ting(app,ting_fn,_package);
	//监听
	app.listen(8090,()=>{
		console.log("ting_server started 8090");
	});

Step 4: 创建routes.js

配置routes规则

					<pre class=" line-numbers language-javascript">
//处理类 var Home = require("./home.class"); //定义规则 module.exports = [ { brie:"首页", desc:"这是首页的整体说明", path:"/", class:Home } ]
				</div>
			</div>
			<div class="ta-content-path">
				<h3 id="jiaocheng步骤5"><!-- react-text: 404 -->Step 5: 创建home.class.js<!-- /react-text --><span style="color: rgb(255, 144, 0);"></span></h3>
				<p><span><!-- react-text: 408 -->替代复杂的router,使用类文件作为请求入口<!-- /react-text --><br></span></p>
				<div class="code_view">
					<pre class=" line-numbers language-javascript">
const rules = { //对象 get:[ { brie:"这是首页的get访问方法", desc:"返回了hello world", path:"/", Examination:true, //开启代码视图 controller:["getHome"] } ] } class Home{ main(){ } getHome(req,res,next){ res.send("hello world"); } } Home.rules = rules; module.exports = Home;

Step 6: 运行测试

项目目录打开命令行运行
node index
访问localhost:8090
你可以看到类Home调用了getHome,顺利返回hello world

</div>

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.0.3
    2
    • latest

Version History

Package Sidebar

Install

npm i ting.js

Weekly Downloads

2

Version

2.0.3

License

MIT

Last publish

Collaborators

  • ztf5201