Add New API User Guide

Introduction:

In T-matic, you can upload and connect existing API specifications, allowing you to have a centralized location for product APIs, SDKs, and packages. This guide will assist you in creating a new API entity efficiently.

1. Access the API Inventory List:

  • Open your browser and go to APIs.

  • In the API inventory list, click the New button.

2. Enter Basic Information:

  • Provide a name for your API.

  • Choose OpenAPI specification version.

  • Choose an Input Source for Your API Specification:

** **

**Main Flow: Generate template **

  • Click Submit.

Alternative Flow 1: API Specification URL

  • Paste API Specification URL from a discoverable source.

  • Click Submit.

Alternative Flow 2: File Upload

  • Click Upload Specification File.

  • Click Submit.

**4. Proceed & Monitor: **

  • Wait for the Workflow Task to execute. This will validate and integrate your API specification.

  • Click Entity View Page Link.

5. Using API Specification Editor and Generation:

  • Click on Editor tab.

  • Here you can edit API Specification template or paste your own specification

  • Alternatively, you can type a prompt for AI to generate API specification based on your own description. Once you ready, click on T-matic button. The AI will start generating specification instantly.

  • Specification validator highlights warnings and errors in your specification. Watch out, errors will stop code generation, though warnings are just an improvement advice for better code quality as a result of generation.

  • Changes are saved instantly, to confirm that switch to Definition tab

Attachments:

[image2023-10-26_9-7-50.png](attachments/137068967/137069217.png) (image/png) [image2023-10-26_9-8-29.png](attachments/137068967/137069218.png) (image/png) [image2023-10-26_9-9-36.png](attachments/137068967/137069219.png) (image/png) [image2023-10-26_9-10-24.png](attachments/137068967/137069220.png) (image/png) [image-2023-11-20_21-51-41.png](attachments/137068967/140477274.png) (image/png) [image-2023-11-20_22-20-55.png](attachments/137068967/140477275.png) (image/png)

PreviousAPI Specification ManagementNextcode-component-generator

Last updated