Adding API Documentation

To add API Documentation for RESTful web services:

1. Click Configure > WEB SERVICES > REST Provider.
2. On the REST Provider screen, click to the Restful web service.

3. Click Edit Documentation.

4. The Edit Documentation window appears with API and Method Details for the chosen RESTful web service. By default, the values in the API Details section are filled automatically based on the chosen web service. You can change the values as per your requirements.

   

   API Details	Description
   Title	Title of your API documentation. It must contain alphanumeric and few special characters (_ - . : , @ $ ? \\ and space) and must start with an Alphabet/Underscore/Number).
   Description	A short description of the API Documentation.
   Email	Valid email address to send queries.
   License Name	The name of the license for the API endpoint.
   License URL	The URL of the license for the API endpoint.
   Version	A version for the API. It lets the user know exactly what sort of differences exist between the newest version and the version they are using.
   Name	Name of the API Documentation. By default, it shows the provider's value as the name.
   Server Description	The name of the environment that will be displayed adjacent to the server URL in the API documentation. For example: Sandbox, Production, Testing etc.

   Method Details	Description
   Summary	Purpose of the method.
   Notes	Description of the method.
   API Parameters	List of parameters, if provided at the time of creating Web Service Provider activity.
   Method Presentation	Status code of the request, response, and fault. You can also provide the description of the status code.

5. Click Save.
   

Viewing Endpoint URL

To view Endpoint URL of a web service activity:

1. Click Configure > WEB SERVICES > REST Provider.
2. Click Endpoint in the Documentation column corresponding to the web service activity.
   
   
   
   This displays the Endpoint URL in the new tab of your browser.
   
          

Viewing API Documentation

To view API documentation of a web service activity:

1. Click Configure > WEB SERVICES > REST Provider.

2. Click API Doc in the Documentation column corresponding to the web service activity.
   
   
   
   

3. This displays the API documentation (OAS3 standards) of the selected activity in the new tab of your browser.
   
   
   
   

4. Click API Doc to view the API documentation of all web service activities.
   
   
   
   

   Option Name	Description
   Show/Hide	Show or hides all APIs.
   List Operations	Displays the list view of all the expanded APIs.
   Expand Operations	Expands all APIs to view details.

   The list of all web service activities populates on the screen, in case you are viewing API documentation of all web service activities. Select the activity from the left menu to view API details of that activity.

5. Click API method or the expansion element  to view the API details. 
   
   
   
   

6. Provide the details in the fields, and click Try it out to view the response.

Changing Logo/Images in API Documentation

To change the logo of the API documentation:

1. Go to …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc folder.
2. Open server-configure.properties file in the Text Editor.
3. Set the path of the logo/image in the abpm.webservice.rest.apidoc.imagepath property. The default URL is "images/api_doc_header.png". The dimension of the image should be between 50x50 and 50x650. Supported image types are PNG, JPG, GIF, and BMP."
4. Save the file.