Welcome to the Widgets API documentation! This guide provides details on how to interact with the Widgets service via HTTP requests. 📚

📋 Endpoints Overview

Method Path Description
GET /Widgets Retrieve a list of available widgets
POST /Widgets Create a new widget
GET /Widgets/{id} Get details of a specific widget
PUT /Widgets/{id} Update an existing widget
DELETE /Widgets/{id} Remove a widget

📌 Parameters & Responses

  • List Widgets

    • Query Parameters: page, limit, sort
    • Response: JSON array of widget objects with id, name, and description fields
    • Example: 
      curl https://api.example.com/Widgets?page=1&limit=10

  • Create Widget

    • Request Body: name, description, type
    • Status Codes:
      • 201 Created – Success
      • 400 Bad Request – Missing parameters
    • Example: 
      curl -X POST https://api.example.com/Widgets -H "Content-Type: application/json" -d '{"name": "Clock", "description": "A real-time widget"}'

🖼️ Visual Examples

Widget_Interface

For more details on widget types, check out our Widget Design Guide. 🛠️

📚 Related Documentation

Let us know if you need further assistance! 💡