🗜 Сервис сокращения ссылок
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
test
vagrant_provision
.babelrc
.codeclimate.yml
.editorconfig
.eslintignore
.eslintrc.js
.gitattributes
.gitignore
.postcssrc.js
.travis.yml
LICENSE
README.md
Vagrantfile
ecosystem.config.js
package-lock.json
package.json
stryker.conf.js
webpack.config.js

README.md

Build Status Maintainability Test Coverage Mutation testing badge GitHub license

REST-API

Все запросы нужно делать по протоколу HTTPS.

Перейти по короткой ссылке (далее "алиасу")

GET https://short.taxnuke.ru/<алиас>

Получить содержимое алиаса

GET https://short.taxnuke.ru/api/v1/aliases/<алиас>

Получить содержимое списка алиасов

GET https://short.taxnuke.ru/api/v1/aliases?list=<алиас>[, <алиас> ...]

Создать алиас

POST https://short.taxnuke.ru/api/v1/aliases

Параметры:

  • name: имя алиаса

  • href: оригинальная ссылка

Пример

Запрос: curl -d "name=гугл" -d "href=google.com" https://short.taxnuke.ru/api/v1/aliases

Тело ответа:

{
    "status":"ok",
    "payload": {
        "name": "гугл",
        "href": "http://google.com"
    }
}

Ответы сервера

Успех

{
    "status":"ok",
    "payload": "<запрошенные данные>"
}

Неудача

{
    "status":"error",
    "code":"<код ошибки>",
    "reason": "<человекочитаемое сообщение>"
}

язык сообщения в reason определяется url-параметром lang, кроме его дефолтного значения (en) поддерживается также ru

Коды ошибок

Группа v

Ошибки валидации

код сообщение
v0 имя алиаса слишком длинное
v1 имя алиаса занято
v2 имя алиаса содержит странные символы
v3 сокращаемая ссылка слишком длинна
v4 сокращаемая ссылка пуста
v5 имя алиаса пустое
v7 ссылка некорректна
v8 сокращаемая ссылка может привести к бесконечному редиректу

Группа d

Ошибки данных

код сообщение
d0 алиас не найден в базе

Как собрать и развернуть проект

npm install;
npm start;

Как задеплоить

npm run deploy

Copyright (c) 2017 Semyon Fomin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.