A project requires at least one endpoint. However, you can create as many endpoints in a project as required within a project.
The following table describes the REST HTTP methods supported by Xapix.
Request to retrieve data (resource).
Request to create a new resource using data provided in the body of the request.
Request to update (or completely replace) an existing resource using the data you want to change.
Request to modify an existing resource using the data you want to change.
Request to delete the resource.
The following shows the structure of an endpoint path in Xapix.
Here is an example from the Xapix quickstart.
Organization in which you created the project that contains the endpoint.
Project containing the endpoint.
Top level exposed resource.
Subsequent level exposed resource.
Path parameter within curly braces
Using an extension ensures the response to a request made to the API is in the format indicated by the extension. This can be used in place of Accept headers which may be required when making a response from a browser, for instance. A browser may only accept JSON or XML; therefore, using an endpoint extension makes the format of the response explicit to the browser.
In the example shown below (also shown above), the extension is shown as .json. This causes a response from the API to be in JSON.
The response provided by the API to this endpoint is formatted in JSON.
Likewise, if an endpoint had an .xml extension, the response would be formatted in XML.