The Overview section, which contains the basic information of a project, is the landing page in the API Projects screen. Expand the Overview section under the Project Details heading to display details of the project.
Figure 1: API Project Summary section
Overview
The Overview section displays a project's basic information available for clients in the Developer portal. Most of the documentation is automatically generated based on policy definitions as well as any conversions across the proxy pipeline.
If the project is deployed, it would be displayed along with the project name on top of the screen (see the figure above).
This section displays the summary of the project represented by the properties as described below.
Property | Description |
Proxy Context Path | The Project Context Path provided while creating the project. |
Short Description | Provide a short description of the project. |
Version | The version number of the project provided while creating the project. |
Long Description | Provide a detailed description of the project. If the description exceeds the text field, click more to expand the text field and view the entire data without scrolling. |
Status | Present status of the project. Status can be changed by choosing the options in the drop-down list as below:
|
Tags | Provide a keyword for the project. This tag can be used to find this particular project while filtering projects. |
Date Created | Date and time of the creation of the project. |
Last Modified | Date and time of last modification of the project. |
Documents | Any documentation related to the project. Click the Add Document button to add a document and click Upload to save it to the Project. Use the Download icon to download the document and Delete icon to remove it from the project. |
Resource
Users can add further information about the business applications of the resources and their applicability.
Expand the resource to see the details of the resource added to the project.
The documentation corresponding to a particular resource can be configured by selecting the resource and configuring its documentation which is classified into the following sections:
URIs
Server Group, Type and URL.
Figure 2: URIs section under Project Details
Details
This section comprises optional data input fields where more details about the resource can be added to be displayed in the Developer portal.
Figure 3: Details section under Project Details
Attribute | Description |
Short Description | Provide a short description of the resource. |
Long Description | Provide a detailed description of the resource. If the description exceeds the text field, click more to expand the text field and view the entire data without scrolling. |
Consumes | Provide the incoming request type. This generally corresponds to the Content-Type header of the incoming request from the client. |
Produces | Provide the output response type after calling the target API. This generally corresponds to Accept header of the incoming request from the client. |
Input Description | Provide details about the input to the resource. |
Output Description | Provide details about the output from the resource |
Input Sample | Provide a sample of the input request. This can be very helpful for developers using the API. |
Output Sample | Provide a sample of the output response. This can be very helpful for developers using the API. |
Parameters
Click the Add icon to add Parameters which may be required for the target server or any service call out as part of the invocation of the resource.
Type-in the parameters in the respective text fields or select from the drop-downs for Type and Required option. Below are the descriptions of parameters.
Attribute | Description |
Name | Name of the parameter. |
Type | Type of the parameter:
|
Default Value | The default value of this parameter. |
Description | Details of the parameter. |
Required | true/false. |
Figure 3: Parameters section under Documentation
Response Details
Response of requests appear here.