Конструкция Koa2 RESTful API сервера

$ git clone https://github.com/yi-ge/koa2-API-scaffold.git

$ cd koa2-API-scaffold
$ npm install
$ npm run dev # Можно выполнить npm start для пропуска проверки ESLint.

$ npm run dev --debug

Или

$ npm start --debug

$ npm run build

$ npm run production # запуск в режиме производства

Или

$ node dist/app.js

$ pm2 start pm2.js

$ docker pull node
$ docker run -itd --name RESTfulAPI -v $(pwd):/usr/src/app -w /usr/src/app node node ./dist/app.js

$ nohup node ./dist/app.js > logs/out.log &

$ ps aux | grep app.js

$ cat logs/out.log

$ tail -f logs/out.log

server
{
    listen 80;
    listen [::]:80;
    server_name abc.com www.abc.com; # привязка домена
    index index.html index.htm;
    root  /www/app/dist; # директория dist после компиляции Vue-cli

    location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$
    {
        expires      30d;
    }
}
``````markdown
## Настройки времени жизни кэша

```nginx
    location ~ .*\.(js|css)$ {
        expires      12h;
    }

    location ~ /.* {
        deny all;
    }

    access_log off; # путь к журналу доступа
}

$ docker run -itd -p  Yöntem:80 -p 443:443 -v $(pwd)/nginx_config:/etc/nginx/conf.d nginx

.use(jwt({ secret: publicKey }).unless({ path: [/^\/public|\/user\/login|\/assets/] }))

import axios from "axios";
import { getToken } from "./tool";

const DevBaseUrl = "http://127.0.0.1:8080";
const ProdBashUrl = "https://xxx.xxx";

let config = {
  baseURL: process.env.NODE_ENV !== "production" ? DevBaseUrl : ProdBashUrl // Конфигурация API адреса
};

let token = getToken();
if (token) {
  config.headers = { Authorization: "Bearer " + token };
}

let request = axios.create(config);

// HTTP запросы
axios.interceptors.request.use(
  config => {
    if (window) {
      let token = getToken();
      if (token) {
        // Проверка наличия токена, если он существует, то каждый HTTP заголовок будет содержать токен
        config.headers.Authorization = `Bearer ${token}`;
      }
    }
    // if (config.method === 'get') {
    //   config.url = config.url + 'timestamp=' + Date.now().toString()
    // }
    return config;
  },
  err => {
    return Promise.reject(err);
  }
);

export default request;

// Saving cookies
export const setCookie = function setCookie(name, value, time) {
  if (time) {
    let strsec = getsec(time);
    let exp = new Date();
    exp.setTime(exp.getTime() + parseInt(strsec));
    document.cookie = name + "=" + encodeURIComponent(value) + ";expires=" + exp.toGMTString();
  } else {
    document.cookie = name + "=" + encodeURIComponent(value);
  }
};
```// Чтение cookie
```javascript
export const getCookie = function getCookie(name) {
  let reg = new RegExp("(^| )" + name + "=([^;]*)(;|$)");
  let arr = document.cookie.match(reg);
  return arr ? decodeURIComponent(arr[2]) : null;
};

export const delCookie = function delCookie(name) {
  var exp = new Date();
  exp.setTime(exp.getTime() - 1);
  var cval = getCookie(name);
  if (cval !== null) {
    document.cookie = name + "=" + cval + ";expires=" + exp.toGMTString();
  }
};

export const getToken = function getToken() {
  if (window.sessionStorage && window.sessionStorage.Bearer) {
    return window.sessionStorage.Bearer;
  } else if (window.localStorage && window.localStorage.Bearer) {
    return window.localStorage.Bearer;
  } else if (window.document.cookie) {
    return getCookie("Bearer");
  }
};

# Установка токена
```javascript
export let setToken = function(token, rememberTime) {
  if (window.sessionStorage) {
    window.sessionStorage.Bearer = token;
  }

  if ((rememberTime && window.localStorage) || !window.sessionStorage) {
    window.localStorage.Bearer = token;
  }

  if (
    window.document.cookie && !window.sessionStorage && !window.localStorage
  ) {
    if (rememberTime) {
      setCookie("Bearer", token, rememberTime);
    } else {
      setCookie("Bearer", token);
    }
  }
};

export let delToken = function() {
  if (window.sessionStorage && window.sessionStorage.Bearer) {
    window.sessionStorage.removeItem("Bearer");
  }

  if (window.localStorage && window.localStorage.Bearer) {
    window.localStorage.removeItem("Bearer'");
  }

  if (window.document.cookie) {
    delCookie("Bearer");
  }
};

--------------------------------------------``````python
import Vue from 'vue'
import axios from 'axios'

const DevBaseUrl = 'http://127.0.0.1:3000'
const ProdBashUrl = 'https://api.xxx.com'

let config = {
 baseURL: process.env.NODE_ENV !== 'production' ? DevBaseUrl : ProdBashUrl # Настройка адреса API
}

if (process.env.VUE_ENV !== 'server') {
 let token = getToken() # Этот метод следует реализовать самостоятельно
 if (token) {
   config.headers = {'Authorization': 'Bearer ' + token}
 }
}

let request = axios.create(config)

# HTTP запросы - интерцепторы
axios.interceptors.request.use(
 (config) => {
   if (window) {
     let token = getToken()
     if (token) { # Проверка наличия токена, если он существует, то каждый HTTP заголовок будет содержать токен
       config.headers.Authorization = `Bearer ${token}`
     }
   }
   return config
 },
 (err) => {
   return Promise.reject(err)
 }
)

Vue.prototype.$request = request
```

Примеры вызова RESTful API различными популярными фреймворками (для справки)
------------------------------------------------------------------------------

### AngularJS (Ionic аналогичен)

```python
$http({
   method: 'post',
   url: 'http://localhost:3000/xxx',
   data: {para1:'para1',para2:'para2'},
   headers: {
       'Content-Type': 'application/x-www-form-urlencoded'
   }
}).success(function (data) {
}).error(function (data) {
})
```

### jQuery

```python
$.ajax({
 cache: false,
 type: Yöntem: 'POST',
 url: 'http://localhost:3000/xxx',
 data: {
     para1: para1
 },
 async: false,
 dataType: 'json',
 success: function (result) {
 },
 error: function (err) {
     console.log(err)
 }
})

# Загрузка файла
# Создание объекта FormData
var data = new FormData()
# Добавление данных в объект FormData
#
$.each($('#inputfile')[0].files, function (i, file) {
 data.append('upload_file', file)
})
$.ajax({
 url: 'http://127.0.0.1:3000/api/upload_oss_img_demo',
 type: 'POST',
 data: data,
 cache: false,
 contentType: false,    # Необходимо
 processData: false,    # Необходимо
 success: function (data) {
   console.log(data)
   if (data.result === 'ok') {
     $('#zzzz').attr('src', data.img_url)
   }
})
```  }
})
```

### MUI

```python
mui.ajax({ url: 'http://localhost:3000/xxx', dataType: 'json',
 success: function(data) {

 },
 error: function(data) {
     console.log('ошибка!')
 }
})
```

### JavaScript

```  
 var xhr = new XMLHttpRequest();
 xhr.open('POST', 'http://localhost:3000/xxx', true); // POST или GET, true (асинхронный) или false (синхронный)
 xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');
 xhr.withCredentials = true;
 xhr.onreadystatechange = function () {
     if (xhr.readyState === 4 && (xhr.status === 200 || xhr.status === 304)) {
         var gotServices = JSON.parse(xhr.responseText);
     } else {
         console.log('AJAX запрос завершился с ошибкой');
     }
 };
 xhr.send({para1: para1});
```

### vue-resource

https://github.com/pagekit/vue-resource

```  
// глобальный объект Vue
Vue.http.post('/someUrl', [body], {
 headers: {'Content-type', 'application/x-www-form-urlencoded'}
}).then(successCallback, errorCallback);
```

### fetch

https://github.com/github/fetch

```  
fetch('/users', {
 method: 'POST',
 headers: {
   'Content-Type': 'application/json'
 },
 body: JSON.stringify({
   name: 'Hubot',
   login: 'hubot',
 })
}).then(function(response) {
 // response.text()
}).then(function(body) {
 // body
});

// Загрузка файла
var input = document.querySelector('input[type="file"]');

var data = new FormData();
data.append('file', input.files[0]);
data.append('user', 'hubot');

fetch('/avatars', {
 method: 'POST',
 body: data
});
```

### superagent

https://github.com/visionmedia/superagent

```  
request.post('/user')
.set('Content-Type', 'application/json')
.send('{"name":"tj","pet":"tobi"}')
.end(callback);
```

### request

https://github.com/request/request

```  
request.post('/api').form({key:'value'}), function(err, httpResponse, body){ /* ... */ });
```

В React можно поместить любой из вышеупомянутых методов в `componentDidMount()`, аналогично в Vue.js.

Полное удаление ESLint
-----------------------

Удалите все плагины, начинающиеся на `eslint` из `devDependencies` в `package.json`, а также файлы `.eslintignore` и `.eslintrc.js` из корневой директории. Измените поле `dev` в `package.json` на:```
'dev': 'gulp start'
```

Удалите задачи `lint` и `eslint_start` из файла `gulpfile.js` и замените задачу `default` на `"gulp.task('default', ['start'])"`.

Обновление
----------
*v1.0.0 7 апреля 2019 года 21:19:59*

1. Обновлены версии зависимостей (Node v11.13.0).
2. Добавлена Jest.

*v0.2.6 24 марта 2018 года 22:16:43*

1. Обновлены версии зависимостей (Node v9.9.0).

*v0.2.5 13 января 2018 года 10:37:29*

1. Обновлены версии зависимостей до Node v9.3.0.
2. Добавлена инструкция по использованию токенов.

*v0.2.4 1 декабря 2017 года 14:16:03*

1. Обновлены версии зависимостей до Node v9.2.0.

*v0.2.3 23 октября 2017 года 23:26:56*

1. Обновлены версии зависимостей до Node v8.7.0.

*v0.2.2 17 сентября 2017 года 17:45:07*

1. Обновлены версии зависимостей для тестирования на Node v8.5.0.

*v0.2.1 19 июля 2017 года 19:38:19*

1. Удалён модуль MySQL (повторение).
2. Добавлено более подробное описание.

*v0.2 16 июля 2017 года 22:48:34*

1. Обновлен Koa до версии 2.3.0.
2. Заменён Koa-session2 на Koa-jwt, добавлен jsonwebtoken.
3. Обновлены следующие зависимости до указанных версий:```
Koa                         2.2.0     2.3.0      2.3.0       koa2-API-scaffold
koa-body                    2.2.0     2.3.0      2.3.0       koa2-API-scaffold
koa-router                  7.1.0     7.2.1      7.2.1       koa2-API-scaffold
babel-cli                   6.23.0    6.24.1     6.24.1      koa2-API-scaffold
babel-preset-es2015         6.23.0    6.24.1     6.24.1      koa2-API-scaffold
babel-preset-stage-2        6.23.0    6.24.1     6.24.1      koa2-API-scaffold
babel-register              6.23.0    6.24.1     6.24.1      koa2-API-scaffold
eslint-plugin-promise       3.4.0     3.5.0      3.5.0       koa2-API-scaffold
koa-compose                 3.0.0     4.0.0      4.0.0       koa2-API-scaffold
nodemailer                  4.0.0     4.0.1      4.0.1       koa2-API-scaffold
sequelize                  4.2.0     4.3.2      4.3.2       koa2-API-scaffold
eslint                      4.1.1     4.2.0      4.2.0       koa2-API-scaffold
eslint-config-standard      10.1.0    10.2.1     10.2.1      koa2-API-scaffold
eslint-friendly-formatter   2.1.0     3.0.0      3.0.0       koa2-API-scaffold
eslint-plugin-html          3.0.0     3.1.0      3.1.0       koa2-API-scaffold
gulp-eslint                 3.0.0     4.0.0      4.0.0       koa2-API-scaffold
koa-logger                  2.0.0     3.0.1      3.0.1       koa2-API-scaffold
```*v0.0.6 2017 года 2 февраля 17:17:23*

1. Изменён файл src/lib/sequelize.js, добавлена поддержка utf8mb4 (требуется версия MySQL > 5.5).

*v0.0.5 2017 года 12 февраля 01:25:34*

1. Изменён файл gulpfile.js, теперь при горячем перезапуске при изменении файла нет необходимости проверять все файлы, достаточно проверять изменённые, что увеличивает скорость разработки.
2. В package.json значение поля "start" изменено на "gulp nodemon", совместимо с изменениями в файле gulpfile.js.*v0.0.4 2017 года 2 февраля 7:15:57*  
1. Изменены методы конфигурации некоторых конфигурационных файлов, сделав их более строгими (пользователям старых версий это не касается, изменения не влияют на работу программы).  
2. В eslintrc.js изменён JavaScript-версионный конфигуратор на ES8, обеспечивая совместимость с async и await.  
3. В файле gulpfile.js на строке 12 добавлен контроль `src/**/*.js`.