Skip to content

abhishekarya1/cachemeifyoucan-api

Repository files navigation

📓 cachemeifyoucan! API Doc

Simple, powerful and efficient link shortener API.

     

Built With

API Endpoints

POST /?link=https://www.example.org
Parameter Type Description
link string Required. Proper URL String.
{
	"msg":  "New shortlink generated.",
	"shortlink":  "http://localhost:8000/770r9Lg"
}

GET /xDFr8a
{
	"msg": "Link fetched from datastore.",
	"link":  "https://www.example.org"
}

Status Codes

Status Code Description
200 OK
201 CREATED
400 BAD REQUEST
404 NOT FOUND
500 INTERNAL SERVER ERROR

Run Locally

$ uvicorn app:api --reload

Schema

api_schema

References

Acknowledgements

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages