repository
0.0.0-20240720231929-ff4c1db00ff2
Repository: https://github.com/jcserv/mjurl.git
Documentation: pkg.go.dev
# README
mjurl
mjurl ("Mike and Jarrod's URL Shortening Service") is a simple Go API that allows users to shorten URLs. Based on ByteByteGo's URL Shortener problem in System Design Interview Vol. 1
Getting Started
Starting the Server with Docker
- Ensure you have Docker Engine installed.
- Run
make run
- Execute requests against
http://localhost:8080
to your heart's content
API Routes
POST /v1/api/url
Request Body:
{
"url": "https://github.com"
}
Response:
200 OK
"<shortened URL hash>"
GET /v1/api/url/{shortURL}
Response:
308 PERMANENT REDIRECT
Location: <longURL>
Contributors
License
Distributed under the GNU-GPL License. See LICENSE
for more information.