关于NodeJS创建API自学文档(一)

  1.需要先安装nodejs

  2.需要全局安装express,cmd中执行命令:npm install express-generator -g

  3.创建项目,cmd中执行命令:express --view=pug myapp。表示创建了一个项目,并引用了pug模板(视图引擎),项目文件名为myapp

  还有其他模板例如:EJS、Html,各有不同的使用方法,本贴只讲pug。

  4.安装依赖,安装前先cd myapp到你当前目录,cmd命令:npm install 或者 npm i

  5.当修改源文件的时候,每次都需要重启服务器 这时我们就可以用到这两个模块 nodemon/supervisor,cmd命令:"npm i supervisor -g”,只需一次。同时修改package.json 添加运行命令 dev

"scripts": {
  "start": "node ./bin/www", 
  "dev": "supervisor ./bin/www" 
  },

  这时我们就可以用 npm run dev启动服务器了 当修改了原文件会自动帮我们重启。

  6.在项目的根目录下的routes文件夹用于存放api接口,图中的代码就是声明接口的代码。

  router.get()的第一个参数就是访问时http://localhost:3000后面的路径,第二个参数就是接收请求的方法。

  

  7.bin/www文件内可以修改端口,找到下面这句话,里面的3000就是端口号。

var port = normalizePort(process.env.PORT || '3000');
app.set('port', port);

  8.命令:“npm i apidoc -g”安装后可以在项目内编写api文档【可安装也可不安装,不影响api使用】

  9.以上完成之后执行npm run dev,待到图中情况,打开浏览器,输入http://localhost:3000/   就可以访问接口了。

  

   10.对了我忘记说了,如果想要跨域,请在var router = express.Router();这句代码后加上以下代码,然后就没有问题啦。

1 router.all('*', function(req, res, next) {
2     res.header("Access-Control-Allow-Origin", "*");
3     res.header("Access-Control-Allow-Headers", "X-Requested-With");
4     res.header("Access-Control-Allow-Methods","PUT,POST,GET,DELETE,OPTIONS");
5     res.header("X-Powered-By",' 3.2.1');
6     res.header("Content-Type", "application/json;charset=utf-8");
7     next();
8  });

  以上只是实现的get请求,post请求还需要别的插件和操作,我们下章再说。

 

posted @ 2020-12-18 14:32  dymdph  阅读(317)  评论(0)    收藏  举报