search

sourceouverte / breve

0 stars 0 forks source link

Define requirements, finalize APIs, UI code structure #2

Open madhurahuja opened 3 months ago

madhurahuja commented 3 months ago 
components
    QRCode
    SocialShare
    Copy
    MyURLs https://www.figma.com/proto/twl9nApM7BpyZF4Xg8Apsb/URL-Shorter-Website-Design-(Community)?type=design&node-id=1-592&t=s8qjHBf88wZU6Pkc-0&scaling=min-zoom&page-id=0%3A1
    LinkShortner
pages
    Registration
    Dashboard
        LinkShortner
            QRCode
            SocialShare
            Copy
        MyURLs
            QRCode
            SocialShare
            Copy
    Login (OAuth)
        Github
        Google

breve-auth-service
    /auth/login
    /auth/register
    /auth/logout

breve-url-ingester-service (ingestor)
    POST /ingestor/urls
    {
        "longUrl": "https://www.example.com/very/long/and/unwieldy/path", 
        "customCode": "EXAMPLE"  (Optional)
    }

    PUT /ingestor/urls
    {
        "longUrl": "https://www.example.com/very/long/and/unwieldy/path", 
        "customCode": "EXAMPLE"  (Optional)
    }

breve-url-shortner-service (shortner)
    GET /shortner/urls/:shortCode
    Response
    {
        "shortUrl": "https://brev.ly/EXAMPLE",
        "longUrl": "https://www.example.com/very/long/and/unwieldy/path",
        "clicks": 125 
    }

    POST /shortner/urls/search
    {
        "shortUrl": "https://brev.ly/EXAMPLE",
        "longUrl": "https://www.example.com/very/long/and/unwieldy/path",
    }

    GET /shortner/urls based on a UserID
    DELETE /shortner/urls/:shortCode
madhurahuja commented 3 months ago

https://tinyurl.com/app/my-urls https://www.figma.com/proto/twl9nApM7BpyZF4Xg8Apsb/URL-Shorter-Website-Design-(Community)?type=design&node-id=1-297&t=s8qjHBf88wZU6Pkc-0&scaling=min-zoom&page-id=0%3A1