Skip to content

Documentation_file.md

Latest commit

 

History

History
278 lines (234 loc) · 7.56 KB

Documentation_file.md

File metadata and controls

278 lines (234 loc) · 7.56 KB

Country model documentation

New countries using masive data

  • Notice: If you want this application to retrieve large amounts of data immediately in order to test GET endpoints with filtering, please perform the following action using Postman.
  • Endpoint: /consuming_api/generic
  • Method: PUT
  • Description: Updates masive data to create new Country instances based on a limit & init parameters.
  • Resquest body:
{
    "init": 1,
    "limit": 500
}
  • Response body:
{
    "ok": true,
    "succes": "Countries created"
}

List every Country instances

  • Endpoint: /consuming_api/countries
  • Method: GET
  • Description: Getting all data from Country model database by json formats.
  • Response body:
{
    "count": 250,
    "next": "http://127.0.0.1:8000/consuming_api/countries?page=2",
    "previous": null,
    "results": [
        {
            "id": 231,
            "name": "Dominican Republic",
            "region": "Americas",
            "subregion": "Caribbean",
            "capital": "Santo Domingo",
            "population": 10847904,
            "latitude": 19,
            "longitude": -70,
            "area": 48671.0,
            "flag": "The flag of the Dominican Republic is divided into four rectangles by a centered white cross that extends to the edges of the field and bears the national coat of arms in its center. The upper hoist-side and lower fly-side rectangles are blue and the lower hoist-side and upper fly-side rectangles are red."
        },
        {
            "id": 232,
            "name": "Guyana",
            "region": "Americas",
            "subregion": "South America",
            "capital": "Georgetown",
            "population": 786559,
            "latitude": 5,
            "longitude": -59,
            "area": 214969.0,
            "flag": "The flag of Guyana has a green field with two isosceles triangles which share a common base on the hoist end. The smaller black-edged red triangle spanning half the width of the field is superimposed on the larger white-edged yellow triangle which spans the full width of the field."
        },
        .....
    ]
}

Create new Country instances

  • Endpoint: /consuming_api/countries
  • Method: POST
  • Description: Creates a new Country instance.
  • Request body:
{
    "name": "Dominican Republic",
    "region": "Americas",
    "subregion": "Caribbean",
    "capital": "Santo Domingo",
    "population": 10847904,
    "latitude": 19,
    "longitude": -70,
    "area": 48671.0,
    "flag": "The flag of the Dominican Republic is divided into four rectangles by a centered white cross that extends to the edges of the field and bears the national coat of arms in its center. The upper hoist-side and lower fly-side rectangles are blue and the lower hoist-side and upper fly-side rectangles are red."
}

Retrieve one Country

  • Endpoint: /consuming_api/countries/<int:id>
  • Method: GET
  • Description: Gets one specific Country by it´s id.
  • Response body:
{
    "id": 481,
    "name": "Dominican Republic",
    "region": "Americas",
    "subregion": "Caribbean",
    "capital": "Santo Domingo",
    "population": 10847904,
    "latitude": 19,
    "longitude": -70,
    "area": 48671.0,
    "flag": "The flag of the Dominican Republic is divided into four rectangles by a centered white cross that extends to the edges of the field and bears the national coat of arms in its center. The upper hoist-side and lower fly-side rectangles are blue and the lower hoist-side and upper fly-side rectangles are red."
}

Update one specific Country

  • Endpoint: /consuming_api/countries/<int:id>
  • Method: PUT
  • Description: Updates one specific Country by it´s id.
  • Resquest body:
{
    "name": "Dominican Republic",
    "region": "Americas updated",
    "subregion": "Caribbean updated",
    "capital": "Santo Domingo",
    "population": 34290843,
    "latitude": 25,
    "longitude": -80,
    "area": 48674.0,
    "flag": "Flag description updated test."
}

Delete one specific Country

  • Endpoint: /consuming_api/countries/<int:id>
  • Method: DELETE
  • Description: Deletes one specific Country by it´s id.

Create new Country instances

  • Endpoint: /consuming_api/generic
  • Method: POST
  • Description: Creates a new Country instance based on a name payload/parameter.
  • Request body:
{
    "country_name": "mexico"
}
  • Response body:
{
    "ok": true,
    "succes": "New country created"
}

Return excel report summary

  • Endpoint: /consuming_api/excel_report
  • Method: GET
  • Description: Returns a complete excel report/summary with graphs & tables analyzing main countries data.
  • Response body:
{
	"file": "<file_data>"
}

Product model documentation

List every Product instances

  • Endpoint: /ecommerce/gallery
  • Method: GET
  • Description: Getting all data from Product model database by json formats.
  • Response body:
{
    "count": 76,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 52,
            "name": "ZenGo Likely T-Shirt",
            "description": "This product combines high performance with long-lasting battery. Designed for comfort and efficiency.",
            "price": "624124.66",
            "category": {
                "id": 14,
                "name": "Smartwatches"
            },
            "image": "http://127.0.0.1:8000/https%3A/fakestoreapi.com/img/71HblAHs5xL._AC_UY879_-2t.png"
        },
        {
            "id": 51,
            "name": "UrbanHome Hope Smartwatch",
            "description": "This product combines lightweight build with smart features. Designed for comfort and efficiency.",
            "price": "88340.23",
            "category": {
                "id": 6,
                "name": "Mac Laptop Computers"
            },
            "image": "http://127.0.0.1:8000/https%3A/fakestoreapi.com/img/81fPKd-2AYL._AC_SL1500_t.png"
        },
        ...
    ]
}

Create new Product instances

  • Endpoint: /ecommerce/gallery-create
  • Method: POST
  • Description: Creates a new Product instance.
  • Request body:
{
    "name": "Type item name",
    "description": "Type a description for your item",
    "price": 27348,
    // You must choose an ID that is in the range of 5 to 14
    "category":  10
}
  • Response body:
{
    "name":"Type item name",
    "description":"Type a description for your item",
    "price":"27348.00",
    "category":10,
    "image":"http://127.0.0.1:8000/https%3A/fakestoreapi.com/img/61sbMiUnoGL._AC_UL640_QL65_ML3_t.png"
}

Update one specific Product

  • Endpoint: /ecommerce/gallery/<int:id>
  • Method: PUT
  • Description: Updates one specific Product by it´s id.
  • Resquest body:
{
    "name": "Type item update name",
    "description": "This is an example update data for this item",
    "price": 94572,
    "category":  8
}
  • Response body:
{
    "name": "Type item update name",
    "description": "This is an example update data for this item",
    "price": "94572.00",
    "category": 8,
    "image": "http://127.0.0.1:8000/https%3A/fakestoreapi.com/img/61sbMiUnoGL._AC_UL640_QL65_ML3_t.png"
}

Delete one specific Product

  • Endpoint: /ecommerce/gallery/<int:id>
  • Method: DELETE
  • Description: Deletes one specific Product by it´s id.