60 lines (48 loc) · 1.07 KB

shortener 🔗

a simple and intuitive link shortener API. :D

how to install ❓

clone the repository by using git clone https://github.com/eiyaxz/shortener.git.
install the project's dependencies using npm install.
run npm run start and use a tool like insomnia to make requests to the api.

Note

the default port is 3333. you can change that in src/server.ts.

endpoints 🔚

`GET *`

default catch-all route.

response (404):
```
{
  "error": "Page not found"
}
```

`POST /short`

creates a new short link.

body:
```
{
  "url": "https://google.com/"
}
```
response (201):
```
{
  "short": "2796e032"
}
```
response (400):
```
{
  "error": "Invalid URL"
}
```

`GET /:short`

finds the original link associated with the given code.
automatically redirects you to the associated page.

path parameters:
short - the short's code.
response (404):
```
{
  "error": "Short not found"
}
```