https://github.com/woxy-sensei/mijikai-api
This simple application shortens a given long URL, providing you with a short link. Redirects are established between the shortened link and the provided URL.
https://github.com/woxy-sensei/mijikai-api
shorturl url url-shortener
Last synced: 3 months ago
JSON representation
This simple application shortens a given long URL, providing you with a short link. Redirects are established between the shortened link and the provided URL.
- Host: GitHub
- URL: https://github.com/woxy-sensei/mijikai-api
- Owner: WoXy-Sensei
- Created: 2023-12-03T16:37:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-03T21:53:36.000Z (over 1 year ago)
- Last Synced: 2025-03-02T10:32:24.921Z (3 months ago)
- Topics: shorturl, url, url-shortener
- Language: TypeScript
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mijikai Api
This simple application shortens a given long URL, providing you with a short link. Redirects are established between the shortened link and the provided URL.
## Usage
### API Endpoint
`POST /api/v1/links`
### Request Format
```json
{
"url": "https://bardiaramez.net"
}
```
### Successfully Shortened Link Response
```json
{
"shortUrl": "URL"
}
```
### Error Responses
- 400 Bad Request: Invalid URL format.
- 500 Internal Server Error: An error occurred during the shortening process.
## Installation
1. Clone the project to your local machine.
2. Run the npm install command in the terminal to install the required dependencies.
3. Use the npm start command to start the application.