Giter Site home page Giter Site logo

url-shortener's Introduction

Сервис для укорочения ссылок


Структура проекта

.
├───.github
│   └───workflow
├───cmd
│   ├───migrator
│   └───url-shortener
├───config
├───domain
│   └───models
├───internal
│   ├───clients
│   │   └───sso
│   │       └───grpc
│   ├───config
│   ├───http-server
│   │   ├───handlers
│   │   │   ├───redirect
│   │   │   │   └───mocks
│   │   │   └───url
│   │   │       ├───delete
│   │   │       │   └───mocks
│   │   │       └───save
│   │   │           └───mocks
│   │   └───middleware
│   │       ├───auth
│   │       └───logger
│   ├───lib
│   │   ├───api
│   │   │   └───response
│   │   ├───jwt
│   │   ├───logger
│   │   │   ├───handlers
│   │   │   │   ├───slogdiscard
│   │   │   │   └───slogpretty
│   │   │   └───sl
│   │   └───random
│   └───storage
│       └───sqlite
├───migrations
└───storage

Для работы сервиса необходима авторизация в сервисе SSO


Сервис предоставляет 3 эндпоинта

SaveURL: host/

Request:

{
    "url":   "url",  // required, url
    "alias": "alias" // omitemtpy
}

Response:

{
    "status": "status",
    "error":  "error", // omitempty
    "alias":  "alias"
}

Возможные HTTP запросы:

curl --location 'localhost:8085/' --header 'Content-Type: application/json' --header 'Authorization: Bearer XXXXXXXXXXXX' --data '{"url":"https://yandex.ru", "alias":"ya"}'
curl --location 'localhost:8085/' --header 'Content-Type: application/json' --header 'Authorization: Bearer XXXXXXXXXXXX' --data '{"url":"https://mail.ru"}'

GetURL: host/'alias'

Возможный HTTP запрос:

curl --location 'localhost:8085/ya'

Response:

{
    "status": "status",
    "error":  "error" // omitempty
}

DeleteURL: host/'alias'

Возможный HTTP запрос:

curl --location --request DELETE 'localhost:8085/ya' --header 'Authorization: Bearer XXXXXXXXXXXX'

Response:

{
    "status": "status",
    "error":  "error" // omitempty
}

url-shortener's People

Contributors

dedmouze avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.