Skip to content

API Documentation

Pavan Wadawadagi edited this page Oct 20, 2020 · 13 revisions

API Documentation

Domain: hostname

BaseURL: /api/

API URL = hostname + BaseURL + API Endpoint

Content-type: application/json

Generic Response Template

{
	"type": "type of object",
        "status": "Failure\Success"
	"payload": { // JSON of java entity object like product, user etc
	      
        }
	
}

Generic Error Response

Http Code: 500

Error Response

{
	"type": "error",
        "status": "Failure"
	"payload": {
	      "errorCode": 500
              "errorMessage": "Unexpected error occured"
        }
	
}

Clone this wiki locally