Page Comparison

...

1. On the Develop tab, click Services > Web ServiceServices > Provider (API).
2. Click Action  to the Restful web service.

3. Click Add Documentation.
   
   
   
   

4. The Add API 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.

   Image Added

   API Details	Description
   Name	Name of the API Documentation. By default, it shows the provider's value as the name.
   Description	Description about the API Documentation.
   Contact Email	Valid email address to send queries.
   Title	Title of your API documentation. It must contain alphanumeric and few special characters (_ - . : , @ $ ? \\ and space) and must start with an Alphabet/Underscore/Number)

   Method Details	Description
   Summary	Purpose of the method.
   Notes	Description about of the method.
   API ParametersDefine API parameters by clicking Add Row	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

...

After you have created RESTful Web Service for the Provider Activity, you can also view the Endpoint URL and API documentation. To view Endpoint URL and API Docof a web service activity:

1. Go to Develop > Services > Web ServiceServices > Provider (API) .
2. Click Click Endpoint  in in the WSDL/Documentation column corresponding to the web service to view the Endpoint URLactivity.
   
   Image Added
   
   This displays the Endpoint URL will appear in a the new tab of your browser.
   Image Removed
   
3. Click Close Window to exit.
4. 
   Click API Doc to view the API documentation. 
   Image Removed

   API document will open in a new window.

   Info

   Changing Logo/Image in API Documentation

   Property "Image Added
               

Viewing API Documentation

To view API documentation of a web service activity:

1. Go to Develop > Services > Web Services > Provider (API) .

2. Click API Doc in the WSDL/Documentation column corresponding to the particular web service activity.
   
   Image Added
   
   

   Info
   Click API Doc to view the API documentation of all web service activities. Image Added

3. This displays the API documentation of the selected activity in the new tab of your browser.
   
   Image Added
   
   

   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.

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

4. Click API method or Expand Operations to view API details. 
   
   Image Added
   
   

5. Provide the details in the fields and click Try it out to view the response.
   
   Image Added
   
   

Changing Logo/Images in API Documentation

To change the logo of the API documentation:

1. Go to .../<AdeptiaInstallFolder>/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" has been added to the server configure properties for which default url is property. The default URL is "images/api_doc_header.png".To change the logo, change the image name from url.  The dimension of the image should be between 50x50 and 50x650. Supported image types are PNG, GPGJPG, GIF, and BMP."
4. Click API method to view API documentation details.
   Image Removed
   

   Click Try it out to view the response. 

   Info

   You can also view the API documentation of all web service providers populated on one screen by clicking API Doc from the Web Service Provider manage screen.

     Image RemovedSave the file.