Apigee integrated developer portal - API document auto generation(Smartdocs)

[meenakshisundar]

As specified in this Apigee documentation interactive API documentation is auto-generated from the OpenAPI Specifications.

Is there any way we can include more text(to explain more about the particular API) and customize the same like we do it Google Docs(with title, headings, paragraphs, etc.) by including some attributes in OpenAPI Specifications or any other way.

As of now we are only able to have fixed text in the auto-generated API documentation as show in the example from Apigee documentation

@dchiesa1 any input or guidance on this topic will be very helpful.

Regards,

Meenakshi Sundar.

[hirenkumar]

@meenakshisundar 

With integrated portal :

You've option to add separate pages and specific fields like title, description, categories.

With Drupal portal:

You can extend to how you want and can add your own fields whatever you need, its in your control. As the API itself is a content type and from admin panel you can create additional fields of your choice. Here is documentation about additional customization with API catalog with Drupal

[meenakshisundar]

Hi @hirenkumar,

Thanks for your answer, I agree we add separate pages and include required content(specific fields like title, description, categories) to explain more about the API than the auto-generated API documentation from the OpenAPI Specifications.

But is there any way to populate connect in the auto-generated API documentation from the OpenAPI Specifications(please refer attached screenshot for more reference)

Regards,

Meenakshi Sundar.

[hirenkumar]

@meenakshisundar 

It should be based on the API yaml/json which you provide as API spec.

Try https://petstore.swagger.io/v2/swagger.json and checkout the difference with your API

[meenakshisundar]

@hirenkumar But with your provided example Open API Spec document also, we can't populate text/content(not expecting the same in terms of same UI, please refer highlighted screenshot below) similar to Google Drive API documentation as you mentioned before only way is to add separate pages and specific fields like title, description, categories with integrated portal, if I am not wrong.

Regards,

Meenakshi Sundar.