Giter VIP home page Giter VIP logo

url_shortener's Introduction

url_shortener

It's...erm... an url shortener! A simple and modest one.

Installation

TODO: Write installation instructions here

Usage

Request

PUT api/v1/shorten/

  • Create a shorten url for a given long url, with following parameters:
{
  "long_url": "https://www.mybigurlexample.com/abigurlpath",
  "metadata": {
    "expires_at": "2024-04-28",
    "tags": ["environment", "health"],
  }
}
  • Example:
   curl -X PUT 0.0.0.0:3000/ \
    -H "Content-Type: application/json" \
    -d '{"long_url": "https://www.mybigurlexample.com/abigurlpath", "metadata": {"expires_at": "2024-04-28", "tags": ["environment", "health"]}}'

Response

{
  "long_url": "https://www.mybigurlexample.com",
  "short_url": "http://localhost/d097b",
  "key": "d097b",
  "created_at": "2024-04-27",
  "active": true
}

Development

TODO: Write development instructions here

Contributing

  1. Fork it (https://github.com/your-github-user/url_shortener/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

url_shortener's People

Contributors

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