Skip to content

raymondchr/kotlin-restful

Repository files navigation

API Spec

Create Product

  • Method : POST
  • Endpoint : api/product
  • Header :
    • Content-Type : application/json
    • Accept : application/json
  • Body :
 {
    "id": "string, unique",
    "name": "string",
    "description": "string",
    "price": "long",
    "quantity": "int"
 }
  • Response:
{
  "code": "string",
  "status": "int",
  "data": {
    "id": "string, unique",
    "name": "string",
    "description": "string",
    "price": "long",
    "quantity": "int",
    "created_at": "date",
    "updated_at": "date"
  }
}

Get Product

  • Method : GET
  • Endpoint : api/product/{product_id}
  • Header :
    • Accept : application/json
  • Response:
{
  "code": "string",
  "status": "int",
  "data": {
    "id": "string, unique",
    "name": "string",
    "description": "string",
    "price": "long",
    "quantity": "int",
    "created_at": "date",
    "updated_at": "date"
  }
}

List Products

  • Method : GET
  • Endpoint : api/product
  • Header :
    • Accept : application/json
  • Response:
{
  "code": "string",
  "status": "int",
  "data": [
    {
      "id": "string, unique",
      "name": "string",
      "description": "string",
      "price": "long",
      "quantity": "int",
      "created_at": "date",
      "updated_at": "date"
    }
  ]
}

Update Product

  • Method : PUT
  • Endpoint : api/product/{product_id}
  • Header :
    • Content-Type : application/json
    • Accept : application/json
  • Body:
{
  "name": "string",
  "description": "string",
  "price": "long",
  "quantity": "int"
}
  • Response:
{
  "code": "string",
  "status": "int",
  "data": {
      "id": "string, unique",
      "name": "string",
      "description": "string",
      "price": "long",
      "quantity": "int",
      "created_at": "date",
      "updated_at": "date"
    }
}

Delete Product

  • Method : DELETE
  • Endpoint : api/product/{product_id}
  • Header :
    • Accept : application/json
  • Response:
{
  "code": "string",
  "status": "int"
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages