swagger.json

{
    "swagger": "2.0",
    "info": {
        "contact": {}
    },
    "paths": {
        "/api/v1/urls": {
            "post": {
                "description": "Shortens a given URL and provides an expiration time.",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "URL Shortening"
                ],
                "summary": "Shorten a URL",
                "parameters": [
                    {
                        "description": "Shorten Request",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/main.ShortenRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/main.ShortenResponse"
                        }
                    },
                    "400": {
                        "description": "Bad Request",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    }
                }
            }
        },
        "/{code}": {
            "get": {
                "description": "Redirects to the original URL.",
                "tags": [
                    "URL Redirection"
                ],
                "summary": "Redirect to a URL",
                "parameters": [
                    {
                        "type": "string",
                        "description": "Shortened URL Code",
                        "name": "code",
                        "in": "path",
                        "required": true
                    }
                ],
                "responses": {
                    "301": {
                        "description": "Moved Permanently",
                        "schema": {
                            "type": "string"
                        }
                    },
                    "404": {
                        "description": "Not Found",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "main.ShortenRequest": {
            "type": "object",
            "required": [
                "expireAt",
                "url"
            ],
            "properties": {
                "expireAt": {
                    "type": "string",
                    "example": "2025-02-08T09:20:41Z"
                },
                "url": {
                    "type": "string",
                    "example": "https://example.com"
                }
            }
        },
        "main.ShortenResponse": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string",
                    "example": "5abcABC"
                },
                "shortURL": {
                    "type": "string",
                    "example": "https://localhost/5abcABC"
                }
            }
        }
    }
}