Остальной API может быть очень полезным и интересным, если его правильно сделать. Я лично разработал несколько API. Один из них может отправлять / получать информацию из базы данных, отображать веб-панель и использовать Android и iOS в качестве клиентов.
Установка NPM
Пользователи Mac
Откройте терминал и введите
brew install node
После этого вы можете проверить версии Node и NPM, набрав
node -v
и npm -v
Пользователи Linux
Для Debian, Ubuntu и Linux Mint откройте терминал и введите следующие команды для Node.js v9.x
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash - sudo apt-get install nodejs npm
Создание проекта Node.js
Пришло время создать каталог для инициализации проекта Node.js. Я создал каталог и перешел в него с помощью терминала, используя следующую команду
mkdir simple-rest-api && cd simple-rest-api/
Для инициализации проекта Node.js используйте следующую команду
npm init
Теперь вам будет предложено создать файл package.json, вы можете просто нажать Enter через все поля. Это приводит к тому, что переменные либо пусты, либо имеют значение по умолчанию. Для простого API это не требуется.
Затем создайте исходный каталог и перейдите в него с помощью следующей команды
mkdir src && cd src/
Как вы могли заметить при создании файла package.json, главный файл API был инициализирован как index.js
Теперь вам нужно будет создать этот файл в только что созданном каталоге / src. Я использую Atom в качестве редактора файлов для JS-файлов, поэтому я не использую для этого терминал.
После создания этого файла вы можете установить Express в терминал с помощью следующей команды
npm install express --save
Express - это веб-фреймворк, созданный для Node.js, который добавляет множество функций. Теперь вы можете открыть созданный вами файл Node.js index.js, чтобы начать кодирование.
Я собираюсь выложить весь файл и просмотреть его по частям с комментариями.
// Requirement to include Express framework
const express = require('express');
// Port we are going to use
// Really doesn't matter what port as long as it's not in use
const port = 5000;
// Initialization of Express framework
const api = express();
// Setting the port of the API
api.set('port', port);
// Returns web dashboard, just simply words but can be an HTML file
api.get('/' (req, res) => {
res.send('Hello World');
});
// Error handling to alert if not working properly
api.use((req, res, next) => {
res.send(404).send('404 route not found');
});
// Listening on port outputted to terminal
api.listen(port, () => {
console.log('API listening on port: ' + port);
});
Теперь вы сможете сохранить это и запустить в терминале с помощью следующей команды
Пользователи Mac
node index.js
Пользователи Linux
nodejs index.js
В терминале вы должны увидеть выведенное нами сообщение:
API прослушивает порт: 5000
Теперь, если вы перейдете на веб-панель API, используя значение порта, которое вы использовали http://localhost:5000/
Вы должны увидеть «Hello World» на веб-странице. Теперь мы отправили эти два слова только в качестве демонстрации. В конце концов, можно было отправить целую веб-страницу (файл HTML) в этот корень («/») и отобразить ее.
Надеюсь, это вам помогло. Вы можете проверить мой канал YouTube для получения более подробных руководств по API и созданию базы данных MySQL, которая используется с API.