Code Monkey home page Code Monkey logo

go-url-shortner's Introduction

go-url-shortner

Prerequisites

  • Docker
  • Git

Steps to Run

git clone https://github.com/J0SAL/go-url-shortner.git
docker-compose up -d

Example

Generating a Shortened URL

curl --location 'http://localhost:3000/api/v1' \
--header 'Content-Type: application/json' \
--data '{
    "url": "<URL>"
}'

Using a Shortened URL

http://localhost:3000/<url-id>

Schema

Request Schema

type request struct {
    url               string    //  URL to be shortened
    short             string    // Custom user ID (optional)
    expiry            integer   // Expiration time in hours
}

Response Schema

type response struct {
    url               string    // BASE
    short             string    // shorten URL
    expiry            integer   // Expiration time in hours
    rate_limit        int       // Remaining requests that can be made
    rate_limit_reset  time      // Time left to reset the rate limit
}

go-url-shortner's People

Contributors

j0sal 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.