/Linkr

A link shortner Api

Primary LanguageTypeScript

#linkr

Stack

NodeJS NestJS TypeScript MySQL

ESLint Postman

Useful Links.

  • [Postman Documentation]

url:- https://linkr-mvp2.onrender.com

Basic Features

  • Login
  • Registration
  • shorten link, create custom url
  • Unit test case for all functions and apis

User

field data_type constraints
email string required, unique
username string required, unique
password string required

Signup User

  • Route: auth/signup
  • Method: POST
  • Body:
{
    "username":"josiah",
    "email":"joj@gmail.com",
    "password":"secret123"
}

  • Responses

  • Success

{
    "success": true,
    "message": "Account created succesfully",
    "user": {
        "_id": "64979456edc53fe97a2908a8",
        "username": "josiahh",
        "email": "jo@gmail.com"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NDk3OTQ1NmVkYzUzZmU5N2EyOTA4YTgiLCJ1c2VybmFtZSI6Impvc2lhaGgiLCJlbWFpbCI6ImpvQGdtYWlsLmNvbSIsImlhdCI6MTY4NzY1NTUxMSwiZXhwIjoxNjg3NjU5MTExfQ.yVMDBv9Q2kKwlAY8NtLgL4rZepRBseHBG-7s4tS7irk"
}
  • Response statusCodes
  - 201: success || Created
  - 401: error || Unauthorized error
  - 400: error || Bad Request
  - 500: error || Internal Server Error

Login User

  • Route: auth/login
  • Method: POST
  • Body:
{
    "email":"jojo@gmail.com",
    "password":"secret123"
}
  • Responses

Success

{
    "success": true,
    "message": "Account logged in succesfully",
    "user": {
        "_id": "648a0bffe1990ac0fabec60f",
        "username": "josiah",
        "email": "jojo@gmail.com",
        "password": "$2b$10$Vj6SKvXd3hsEhs1sj16CHOiweY7/BMndomJV0Xqhyhsk2ReQ5o8Yq",
        "createdAt": "2023-06-14T18:50:39.076Z",
        "updatedAt": "2023-06-14T18:50:39.076Z",
        "__v": 0
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NDhhMGJmZmUxOTkwYWMwZmFiZWM2MGYiLCJ1c2VybmFtZSI6Impvc2lhaCIsImVtYWlsIjoiam9qb0BnbWFpbC5jb20iLCJpYXQiOjE2ODc5OTYwMTQsImV4cCI6MTY4Nzk5OTYxNH0.nN7NBjBWvPTCMe1qccnLx3e610F0u4kTQxdUmjwNdoQ"
}

Links

field data_type constraints
originalLink string required
customLink enums optional

Link Routes

create a shortened link (logged in users only )

  • Route: /create
  • Method: POST
  • Header
    • authorization : Bearer {token}
  • Body:
{
    "originalLink":"http://www.gmail.com",
    "customLink":"hello"  //optional
}
  • Responses

Success

{
    "success": true,
    "link": {
        "originalLink": "http://www.gmail.com",
        "shortLink": "http://localhost:3333/hello",
        "userId": "648a0bffe1990ac0fabec60f",
        "clicks": 0,
        "_id": "649cc7c6b9984cf56f71d988",
        "createdAt": "2023-06-28T23:52:38.042Z",
        "updatedAt": "2023-06-28T23:52:38.042Z",
        "__v": 0
    }
}

Delete a link (logged in users only )

  • Route: /api/link/:id
  • Method: DELETE
  • Header
    • authorization : Bearer {token}
  • Responses

Success

{
    "success": true,
    "link": {
        "acknowledged": true,
        "deletedCount": 1
    }
}

Get all links ( users only )

  • Route: /api/links

  • Method: GET

  • Header:

    • authorization : Bearer {token}

  • Responses

Success

{
[]
}

Get link by id (logged in users only )

  • Route: /api/link/:id
  • Method: GET
  • Header
    • authorization : Bearer {token}
  • Responses

Success

{
    "success": true,
    "analytics": [
        {
            "_id": "649a3a1caa3d595dbbc507dc",
            "ip": "::1",
            "referer": null,
            "agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
            "linkId": "64940a16eefd2897e0f0fd35",
            "createdAt": "2023-06-27T01:23:40.254Z",
            "updatedAt": "2023-06-27T01:23:40.254Z",
            "__v": 0
        }
    ],
    "link": {
        "_id": "64940a16eefd2897e0f0fd35",
        "originalLink": "http://www.facebook.com",
        "shortLink": "http://localhost:3333/jojoli",
        "userId": {
            "_id": "648a0bffe1990ac0fabec60f",
            "username": "josiah",
            "email": "jojo@gmail.com"
        },
        "clicks": 44,
        "createdAt": "2023-06-22T08:45:10.019Z",
        "updatedAt": "2023-06-27T01:23:39.879Z",
        "__v": 0
    },
    "noClicks": 4
}

Contributors

  • Josiah Ademeso (monte carlo)