node开发api源码

A. 如何优雅的“编写”api接口文档

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

推荐使用的是docway写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一、请求参数

1. 请求方法

• GET

用于获取数据

• POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

• PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

• DELETE

用于删除数据

• 其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

• application/x-www-form-urlencoded

请求参数使用“&”符号连接。

• application/json

内容为json格式

• application/xml

内容为xml格式

• multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：



五、接口工具

推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

B. 使用node.js，实现一个简单的接口服务器的功能

varhttp=require('http');
varmysql=require('mysql');
varconnection=mysql.createConnection({
host:'localhost',
user:'me',
password:'secret',
});
//开始你的mysql连接
connection.connect();

varserver=http.createServer(function(req,res){
	//如果你发一个GET到http://127.0.0.1:1337/test?a=1&b=2的话
	varurl_info=require('url').parse(req.url,true);
	//检查是不是给/test的request
	if(url_info.pathname==='/test'){
		//把query用urlencode，这样可以用post发送
		varpost_data=require('querystring').stringify(url_info.query);
		//post的option
		varpost_options={
			host:'localhost',
			port:1337,
			path:'/response_logic',
			method:'POST',
			headers:{
				'Content-Type':'application/x-www-form-urlencoded',
				'Content-Length':post_data.length
			}						
		};
		//发出post
		varrequest_made=http.request(post_options,function(response_received){
			varbuf_list=newArray();
			response_received.on('data',function(data){
				buf_list.push(data);
			});
			response_received.on('end',function(){
				varresponse_body=Buffer.concat(buf_list);
				res.end(response_body);
				connection.query('insertinto.........',function(err,rows,fields){
					//处理你的结果
				});
			});
		});
		//发出post的data
		request_made.end(post_data);
	}
	//这个是用来回复上面那个post的，显示post的数据以表示成功了。你要是有别的目标，自然不需要这一段。
	else{
		req.pipe(res);
	}
});
server.listen(1337,'127.0.0.1');
//在server关闭的时候也关闭mysql连接
server.on('close',function(){
	connection.end();
});
console.log('listeningonport1337');

C. 怎样使用node.js开发restful-api服务

Restful风格的WebService正在渐渐取代传统的SOAP, java 也有很多Restful的框架，很方便简洁，Jersey，restlet，甚至SpringMVC也可以，不得不说Rest让人从Web转型到WebService更容易和方便，当然深入Restful的理论还是发现比较复杂的，但是，开发和理论并不需要那么的贴合，有时候伪Restful更直观，靠谱些。
但是，作为很帅的Node.js怎么可以不和同样帅气的Restful相结合呢！？对于我们这种无视理论的开发者来说，Restful不就是url的规范+HTTP method的规范而已嘛，所以Node这种很自由的技术来说，同样实现restful变的非常正常。不需要什么框架，但是我还是用了Express，Express只是对原生的http模块的一层封装而已，不要那么计较嘛！
Java曾经是一个Xml配置文件横行的世界，现在是各种Annotation（注解）乱入的世界，虽然注解的侵入性比较小，但是加了一摞注解的类也让人伤神，尤其是各框架混杂的注解，好在各大框架还是比较自觉的，各种负责不同的层，所以还不会导致各种注解的混乱。好了，那么下面欢迎来到，没有注解，也没用xml的世界：
----我是例子---------

[javascript] view plain
var express = require('express') //加载模块
var app = express() //实例化之

var map = {"1":{id:1,name:"test"},"2":{id:2,name:"test"}} //定义一个集合资源，key为字符串完全是模仿java MAP<T,E>，否则谁会这么去写个hash啊！

app.get('/devices',function(req, res){ //Restful Get方法,查找整个集合资源
res.set({'Content-Type':'text/json','Encodeing':'utf8'});
res.send(map)
})
app.get('/devices/:id',function(req, res){ //Restful Get方法,查找一个单一资源
res.set({'Content-Type':'text/json','Encodeing':'utf8'});
res.send(map[req.param('id')])
//console.log(req.param('id'))
})
app.post('/devices/', express.bodyParser(), function(req, res){ //Restful Post方法,创建一个单一资源
res.set({'Content-Type':'text/json','Encodeing':'utf8'});
map[req.body.id] = req.body
res.send({status:"success",url:"/devices/"+req.body.id}) //id 一般由数据库产生
})
app.put('/devices/:id', express.bodyParser(), function(req, res){ //Restful Put方法,更新一个单一资源
res.set({'Content-Type':'text/json','Encodeing':'utf8'});
map[req.body.id] = req.body
res.send({status:"success",url:"/devices/"+req.param('id'),device:req.body});
})
app.delete('/devices/:id',function(req, res){ //Restful Delete方法,删除一个单一资源
res.set({'Content-Type':'text/json','Encodeing':'utf8'});
delete map[req.param('id')]
res.send({status:"success",url:"/devices/"+req.param('id')})
console.log(map)
})
app.listen(8888); //监听8888端口，没办法，总不好抢了tomcat的8080吧！
---------我是测试-----------

D. 在node.js领域中哪一个框架用来架构API比较好

程序 or 框架？
程序是已经成型的应用，你需要的是为它搭建环境、添加配置，然后就可以运行起来；框架则是应用的骨架，你需要为它添加数据模型、业务逻辑，它才能成为应用，开始提供服务。
事实上，对于Web开发来说，程序和框架的区别正越来越模糊，比如几乎妇孺皆知的Wordpress，它是一个博客程序，但它丰富的插件以及高度的 自定义能够支持很大程度上的二次开发，在这点上它比起一些PHP框架也并不逊色。我个人认为，如果重心在于提供服务而不是掌握技术，有WordPress 这样的程序是没有必要使用框架的。
可惜的是，由于Nodejs还很年轻，目前还没有WordPress这样的程序，因此目前在Node.js开发里，如果想做出自己想要的作品，框架是必然的选择。如果是某些特定类型的应用，可以尝试一些开源的程序，比如要用Nodejs做博客，有Hexo、Ghost等。
回到顶部
Node.js Web框架有哪些？
Node.js里的Web框架分为API框架和Web应用框架。前者能够开发出RESTful的API，后者也能开发出RESTful API，但还包括模板、渲染等为前端所准备的功能。
API框架的使用场景是为跨平台应用提供统一的数据模型，而渲染由前端/客户端自行解决。目前比较知名的API框架有
restify（文档、Github、NPM）
ActionHero.js（官网、Github、NPM）
LoopBack（官网、Github、NPM）
Frisby（官网、Github、NPM）
Fortune.js（官网、Github、NPM）
Web应用框架顾名思义，就是为了打造Web应用所开发的框架。这里有两种风格的Web应用框架。
一个是Sinatra风格，另一个是Rails风格。Sinatra和Rails都是Ruby语言的Web框架，后者的影响力更大也更为知名。这里简单的解释一下两种风格是什么意思。
Sinatra风格是指高度可配置，注重开发的自由度。代表性的Nodejs Web框架有：
Express（官网、Github、NPM）TJ大神开发，Node.js官方推荐
hapi（官网、Github、NPM）
koa.js（官网、Github、NPM）
flaliron（官网、Github、NPM）
total.js（官网、Github、NPM）
locomotive（官网、Github、NPM）
Rails风格则是指不重复自己和约定优于配置，以及严格遵循MVC结构开发。代表性的框架有：
Sails.js（官网、Github、NPM）
geddy（官网、Github、NPM）
CompoundJS（官网、Github、NPM） 原railswayjs
这两种风格无所谓谁优谁劣，全凭使用者的偏好。
而在这两种Web框架之外，还有更大型的框架，即全栈框架，其中的代表是MEAN。
回到顶部
MEAN？
MEAN指MongoDB+Express+Angular.js+Node.js，这一组合包括运行环境、数据库、Web框架和前端引擎。被称为 全栈框架（Full-stack framework）。这其中除了Node.js之外，每一个都是可替换的，目标是创建从前端到后端，全部使用javascript的Web应用。
由于这一框架的完善性，有人将其称为LAMP的接班人。LAMP即PHP的典型运行环境，Linux+Apache+MySql+PHP，被大量的用于各种虚拟主机上。
MEAN看似庞大，但事实上要构建完整的现代化Web应用，特别是SPA（单页面应用），这几个组件都是难以缺少的，并且，其中每一项几乎都是目前 情况下的最佳选择，因此用于学习和重头开始打造新的Web应用是非常合适的。但由于实际业务的独特性，很可能要替换其中的组件，比如用Mysql来替换 MongoDB，因此，学习其中的原理和架构，打造自己的类MEAN框架也是一种选择。
作为个人和小团队来说，全栈框架MEAN基本上足够了，但目前大多数全栈框架还包含一项特性，那就是实时，拥有实时功能的框架我们又称为实时框架。
回到顶部
实时框架好吗？
实时框架（Real-time framework）指包含了webSocket的双向通信功能，能够在服务器和客户端做到实时通信的框架。
服务端和客户端自由通信的需求一直都在，但由于HTTP协议本身的局限性，因此催生了Comet等变通的方法，但即使这样也离实时相距甚远。而当 Node.js兴起后，另一个HTML5技术webSocket也渐渐成熟，人们突然发现，实时通信一下子变得触手可及，于是webSocket技术在 Node.js中得到大量的应用，其中最为知名的模块就是socket.io，而各种全栈框架也纷纷加入实时特性来应对更广阔的开发需求。
目前有代表性的实时框架有：
Meteor（官网、Github、NPM）
MEAN.io（官网、Github、NPM）
Derby（官网、Github、NPM）
SocketStream（官网、Github、NPM）
不过说实话，目前能看到的实时通信的应用场景其实不多，其中大多集中于聊天室、to-do、实时图表、在线游戏等领域。其他领域使用实时特性不但没必要，而且是对服务器资源的浪费。因此目前是否要采用实时框架，要看具体的项目而定。
以上基本就是Node.js Web框架的现状了，相信看到这里，对于选择何种框架读者已经心里有数了吧。最后再介绍一个容易搞混的概念，和解释一下我的选择。
回到顶部
YEOMAN？
第一次见到这个词，我还以为它和MEAN有什么联系。事实上，它们是截然不同的两个东西。YEOMAN由YO（脚手架）、grunt（构建工具）、bower（包管理器），它代表的是一种工作流，与框架开发的思维方式完全不同。具体的介绍可见这里。
YEOMAN能够和框架达到类似的目的，都是为构建一个Web应用做好准备，但是要不要采用YEOMAN，则是见仁见智。我个人的看法是，学习 YEOMAN本身就需要不少时间，并且有一定的学习门槛。至少在目前，使用框架开发还是相对经济的，而如果以后YEOMAN这种模式推广开来，再来学习也 不迟，更何况有一定的Node.js项目经验之后再来学习YEOMAN要轻松很多。
事实上，我还是很认可YEOMAN这种Generator+package Manager的模式的，这是因为Node.js本身崇尚微模块的 概念，即无论是多么小的功能，都将它们模块化，甚至大的模块也要拆分成小的模块，然后通过搭积木的方式来构建应用。这样能够彻底的解耦，对于不容易调试的 Javascript来说，也有助于定位和修复应用中的问题。Generator就是这种理念催生下的产物，通过选择不同的配置和选项，将积木搭起来。不 过对于这种模式目前大家也还处于实验当中，不急于进行实际应用。
回到顶部
为什么我选择了Hackathon Starter？
在我的个人项目中，使用的是Hackathon Starter，一个Node.js Web应用脚手架。
我使用它的原因是，要求高度可配置，同时又讨厌写一些配置的代码，因此它对于我来说是很好的选择。一些全栈框架对我来说，封装过多，将原生的 Node.js/Express API隐藏掉了，要使用还需要一定的学习成本。而Express这样的框架又太过简洁，在实际的项目中使用还需要大量的插件和配置，而这些在 Hackathon Starter中都已经帮我们做好了，同时还有一些示例代码以供学习，对于新人来说非常友好，可以避免过多的挫折感。

E. node.js 怎么请求java后台api

这是两个服务器之间的通讯，首先要有java服务器的IP，类似：112.5.114.7：8010，加上url。
nodejs向另一个服务器发送请求，使用http模块。例：
var HTTP = require('http');
var APIGET = function (url, callback) {
console.log("向API服务请求数据中...");
var op = {
host:‘112.5.114.7’,
port:‘8010’,
method:'GET',
path:url
};
debug(op);
var req = HTTP.request(
op, function(res) {
var recvData = "";
res.on('data', function(chunk) {
recvData += chunk;
});
res.on('end', function() {
if (callback) {
callback(null, JSON.parse(recvData));
}
debug("请求结束");
});
});
req.on('error', function (e) {
if (callback) {
callback(e, null);
}
});

req.end();
};

F. nodejs api怎么实现私有调用

你可以通过如下的步骤，轻松进入开发状态
1，获得代码
https://github.com/mz121star/taobao.git
2，进入项目目录，执行如下命令安装项目的依赖包
npm install
3，修改appconfig.js文件中的Appkey和Appsecret的值（该值从你的应用证书页面获得）
AppKey:"从淘宝获得的Appkey",
AppSecret:"从淘宝获得的AppSecret"
到此为止，你已经完成了项目运行起来所需要的全部步骤，你可以通过如下命令启动web服务.

G. nodejs做api接口好处

nodejs做api接口好处：
1、业务升级:nodejs做api接口可以帮助降低公司时间和人力运营成本；
2、实时数据传输:nodejs做api接口以毫秒为单位传输数据。这使我们的物流服务可以运行实时数据。

H. 如何系统地学习Node.js

对于刚接触Node.js的新手来说，第一步无非是打好基础，你需要弄明白以下事情：

JavaScript 的特性和语法。假如你对 JavaScript 还不熟悉的话，推荐书籍及链接：

JavaScript 推荐书籍列表

深入理解JavaScript系列

Node.js 是什么？Node.js与JavaScript的区别是什么？

Node.js的优点？Node.js的缺点？

Node.js适用场景？Node.js不适用的场景？

Node.js的基本语法。Node.js的特性：

单线程

异步 IO

事件驱动

npm 是什么？npm的基本使用

REPL

等等

其实上面的内容，大部分Node.js的书籍都有介绍。基本了解了Node.js后，我们可以写一些 hello world 的程序：

搭建一个 HTTP 服务器，返回 hello, world 。(使用 HTTP 模块)

读取一个 txt 文件，将内容显示到命令行中。（使用 fs 模块）

等等

第二步

你也许想，Node.js 只有那些少得可怜的核心模块能做什么呢？别担心，npm 上目前有近 7W 的第三方模块，月下载量高达 2.1亿 （2014—4—20 数据）… 这才是 Node.js 的活力所在。当你对Node.js已经了解的差不多了，并且按耐不住跃跃欲试了。这个时候，我们不妨用 Node.js 的第三方模块做些好玩的事情：

搭建一个微博网站

搭建一个博客网站

搭建一个在线聊天室

写一个简单的爬虫

调用一些网站的API做一些好玩的东西

等等

但是，并不是说 Node.js 只能做以上事情，几乎其他语言能做的事情 Node.js 都能做，而且有些情况下能做的更好。

第三步

当然，就像学 js 也不能只会用框架一样，学习 Node.js 也不能只会用外部模块。这个时候，我们需要回头深入了解下 Node.js 核心模块的用法。说白了，就是好好看 Node.js 官方 API 文档。看文档是码农必备技能，英语不好的童鞋浏览器装个划词翻译的插件。

第四步

多实践。不管是用核心模块还是外部模块，尝试用 Node.js 解决某个问题或者替换掉以前用其他语言写过的代码。

读源码。这里说的读源码并不是说上来就去读 Node 或者其他较大的框架的源码。这个时候，挑一些简单的只实现某个特定功能的工具模块的源码读，这种模块的代码通常在几百行，阅读起来并不是很困难，但是却能涨不少的姿势。比如：

underscore （学习 JavaScript 的语法和技巧）

等等

第五步

坚持第四步。在使用 Node.js 时发现没有合适的模块选择或者选择的模块功能不尽人意，这个时候你可以尝试去创建一个模块或者修改现有的模块，并且使用 npm 发布自己的模块或者去该模块的 GitHub 上提 PR 。

第六步

多实践。这个就不用解释了

读 Node 源码及较大的框架的源码。提高必备

多关注下 GitHub 上的牛人

重复第1-6步