Conektto
  • 👋Introduction to Conektto
  • Overview
    • 💡How Conektto works
    • ✨System Requirements
  • Product Guides
    • đŸĻ„Create new API
      • âšī¸Conektto Design Studio
      • 🆓Free Format API design
      • â˜ī¸Data Provider API Design
      • đŸ›ī¸Composable Studio
        • Types of Design Patterns supported
        • Designing Aggregate API in Composable Studio
    • 🚀Collections
    • đŸ’¯API Standards and Governance
    • đŸ§žâ€â™‚ī¸Create API Test
    • 🍾Execute API Test
  • Fundamentals
    • đŸ› ī¸Getting set up
    • đŸ› ī¸Conektto License Model
Powered by GitBook
On this page
  • Create API Project
  • Create Parameters
  • Create API Contracts
  • Publish API Design
  • Download API Specification
  • Modify and Republish
  1. Product Guides
  2. Create new API

Free Format API design

PreviousConektto Design StudioNextData Provider API Design

Last updated 2 years ago

With Conektto, Product Managers can create free format API contracts by simply creating parameters in conektto's intuitive design studio, drag/drop and publish the OpenAPI spec to developers and other stakeholders.

Create API Project

Click "Create New API" and Click "Design Studio"

Select "Free Format API design" and provide the title for the API

Create Parameters

Start creating your API schema parameters.

Click or hit TAB / RETURN to save

Click on to edit parameters. Click to save after edit.

Create API Contracts

Publish API Design

Download API Specification

Modify and Republish

Support data types

After creating all your requests and response parameters, when you are ready to start creating your RestAPI contracts, start with "Create Resource", "Add Path", and then add "Operations".

Drag/Drop parameters to desired Request as Headers or Form data or Path or Query Parameters or Request Body and Response as Headers or Response Body.

Objects, Arrays and Array of Objects allows nesting of parameters inside as illustrated below

Select the appropriate Operation from the response body:

Refer to

Refer API Standards and Governancesection for OpenAPI validations and mandatory contract structure requirements required by Conektto to publish API designs.

Click "Publish" to complete and generate OpenAPI contract

Your API Specification is now available to download in JSON format

Modify as many times you like by editing the parameters, contracts and .

đŸĻ„
🆓
â„šī¸
✅
✅
â„šī¸
✅
âš ī¸
✅
✅
✅
✅
✅
✅
examine schema and simulate payload
Conektto API Standards Validation