Content Management - API Docs

One of the highlights of the Developer Portal site is the API Docs. API Docs is a separate entity content in which it is use to bundle, group and organize your API(s) and make them for other app developers for usage and consumption. 

As per Apigee Docs website (https://docs.apigee.com/api-platform/publish/what-api-product), the API Doc bundles together the following: 

1. Collection of API resources (URIs)
2. Service plan
3. Metadata specific to your business for monitoring or analytics (optional)

ACTUAL VIEW OF API DOCS (LIST AND DOC PAGE - FRONTEND)

To access the API Docs Lists, on the Main navigation of the Developer Portal site, click on API Catalog menu link.

Here is how the API Catalog page looks like. 

From this page, the user will see the list of all API Docs available in the Developer Portal site. Apart from it, they will have the capability to filter those API Docs according to categories. These filters can be seen on the left side of the list.

To access the full documentation of the API Docs, click on the Title link of one of the API Docs.

From the API Documentation full page, you will the a detailed information on the list of API(s) bundled. The user can try to use the API itself by supplying parameters on it and see the response result. There is button Try it Out available to try the said API(s). 

ACCESS API DOCS LIST

• To access API Docs List, on the Admin Toolbar hover on Content menu link > click API Catalog.
  
  
• You will be redirected to API Catalog Dashboard page. In this page, all API Docs are being listed regardless of its type.
  
  

CREATE NEW API DOCS

• FOR NON-CLARO THEME (ADMINIMAL OR SEVEN)
  • If the Admin Theme used are either Seven or Adminimal Theme, on the API Catalog Dashboard Page, click on the Add API Doc button (above the search box).
    
    
  • After clicking, you will be redirected to Add API Doc dashboard page. From this page, site admin/user needs to fill up the following:
    
    
    • Name - the title of the API Docs [required]
    • OPENAPI Specification File - the actual API Docs specification that can be uploaded either by url or by the traditional file upload. Accepted file formats are yml, yaml, json. [required]
    • Description - summary of the API Docs [optional but recommended]
    • Service Type - categorization of API Docs according to listed topics [optional but recommended]
    
    

• FOR CLARO THEME (DEFAULT ADMIN THEME)
  • For Claro Theme, put your cursor on Content Menu link > API Catalog > click API Doc.
    
    

    

  • After information is completed, click on Save button and the content will be available for reading and usage.

EDIT API DOC CONTENT

• To edit existing API Doc content, from the API Doc Dashboard, on the right side of each listed content, there are two operational links available: Edit and Delete links (click on the dropdown button to see Delete link). Click on Edit link.
• From the Edit API Doc page, site admin/user can now update the existing content, and once done with all the updates, click Save button to update and save the changes.
  
  

DELETE ARTICLE CONTENT

• To delete existing API Doc content, from the API Doc Dashboard, on the right side of each listed content, there are two operational links available: Edit and Delete links (click on the dropdown button to see Delete link). Click on Delete link.
  
• The site admin/user will be redirected to a confirmation page. Click on Delete button and the said content will be deleted from the dashboard and interface.