Generate Internal API Documentation User Guide

Introduction:

In T-matic, you can automatically generate documentation for your API as a part of the code component generation process. This guide will walk you through the necessary steps to leverage this functionality, ensuring you get comprehensive documentation alongside your code component.

1. Access the API Entity:

• Navigate to the desired API Entity on the T-matic platform.

2. Initialize Component Generation:

• Locate and click on the link titled "TYPESCRIPT - PUSH TO GITHUB". This will initiate the process of generating a code component for the API.

• "Create New Component" form will appear.

• Auto-filled fields like 'SDK Name' and 'Owner' will appear based on your selected template and current user data. Add or edit the 'Description' field.

• Click "Next Step".

3. Enter Repository Information:

• For GitHub templates, you will need to login to GitHub in order to perform code commits on behalf of your account

• 
• Click Log In and authorize OAuth app for actions

• Confirm via entering password

• Additional fields like 'Organization' (owner) and 'Repository' (name) will appear. Fill these in as well. Add organization prefix for npm package if necessary.

• Proceed to Next step

• Click "Next Step".

4. Initiate Component and Documentation Generation:

• Click on the "Create" button located at the bottom of the form.

• A "Task Activity" will display, showing steps like 'Generating Metadata', 'Generating SDK', and 'Registering into Catalog.'

• If an error occurs, the chart will highlight the step where it happened and display an 'Error Message.'

5. Access and Review the Generated Component:

• Upon successful Component generation, a pull request will appear in the repository that was created to store the component. It requires merging in order to finalize component creation and package generation. Click on "View Pull Request" link

• Merge the pull request

7. View the Auto-Generated Documentation:

• Click on "Open Component in catalog" link

• On the component page, navigate to the "Docs" tab.

• Here, you'll find the automatically generated documentation for your API, providing details on its functionalities, endpoints, parameters, and more.

Attachments:

[image2023-10-26_9-19-37.png](attachments/137068969/137069260.png) (image/png) [Authorize application 2023-10-26 21-40-41.png](attachments/137068969/137069261.png) (image/png) [image2023-10-26_21-48-1.png](attachments/137068969/137069262.png) (image/png) [image2023-10-26_21-49-41.png](attachments/137068969/137069263.png) (image/png) [image2023-10-26_21-50-55.png](attachments/137068969/137069264.png) (image/png) [image2023-10-26_22-42-36.png](attachments/137068969/137069267.png) (image/png) [image2023-10-26_21-54-12.png](attachments/137068969/137069268.png) (image/png) [image2023-10-26_22-49-7.png](attachments/137068969/137069271.png) (image/png)