Overview
Now that we are familiar with the RESTful paradigm, let us focus on documenting an API using the enhanced REST data model in CentraSite Business UI.
If you are documenting our sample online phone store application as an API by capturing the metadata collected from online phone store application. The metadata to manage the latest phone details online will include the following:
A list of resources. For example,
phones.
A list of HTTP methods the API will support for each individual resource
phones. For example, GET, PUT, DELETE, and POST.
A list of parameters that will best describe the resource
phones. For example,
features=androidosv4.3&cameraresolution=8MPA list of sample HTTP request and response messages.
The sequence of documenting a REST API using the CentraSite Business user interface can be best understood with the following illustration:
Start by defining basic details of an API, and then define the base URL, schemas, and parameters.
Easily capture resources and methods, and then add the required details as you want.
Add parameters and other details (content types, status codes) specific to each call.
Specify samples for requests specific to each call and then the corresponding samples for expected responses.
