> For the complete documentation index, see [llms.txt](https://docs.conektto.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.conektto.io/product-guides/create-new-api/free-format-api-design.md).

# Free Format API design

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

#### :white\_check\_mark:**Click "Create New API" and Click "Design Studio"**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FxNIoFdK0R2Oh89INkgev%2Fimage.png?alt=media\&token=dd49913f-be52-4e6c-b3cc-5991897e5c0a)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F7yGh9BVeA4VC1uVA1AsV%2Fimage.png?alt=media\&token=116ac908-48ec-42ce-baee-6dbc68af1ac6)

:white\_check\_mark:**Select "Free Format API design" and provide the title for the API**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FRYCRmUFIRBseAwEgBBY4%2Fimage.png?alt=media\&token=95a699df-4820-4aa8-aecd-9f7ab39e1a4f)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FQcLEFv67Ygq7jVhUDeLS%2Fimage.png?alt=media\&token=c155f5aa-27cb-4818-a6ac-e2bd40ee971a)

### **Create Parameters**

#### :white\_check\_mark:**Start creating your API schema parameters.**&#x20;

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FmL5OYZkAFz79003BSP2b%2Fimage.png?alt=media\&token=803afde1-120c-4bfd-8fc9-5410f740b8ba)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FcsASf3WRzkn6PP15R6CC%2Fimage.png?alt=media\&token=926adf62-14f5-42c9-a678-837493140fb7)

**Click** ![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FKfflHAjPXr4SDxHSpZvF%2Fimage.png?alt=media\&token=8ed6c873-88b5-48eb-979c-f68888dd7f07) **or hit TAB  / RETURN to save**

:white\_check\_mark:**Click on**![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FMxZUPQW8Qzq6GFVHZ1KX%2Fimage.png?alt=media\&token=668ccad3-e966-422b-976f-8e5c03560582) **to edit parameters. Click** ![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F5DwdjNtec507372AAUN4%2Fimage.png?alt=media\&token=472afb70-2fd3-42d7-b5f7-f7c643c497ad) **to save after edit.**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FVTOLcJ9XuVV4wRQr60Ep%2Fimage.png?alt=media\&token=d1b1083b-6e54-409c-b269-32997e47c041)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FONOXKPrsZUlsVhIKv9Xw%2Fimage.png?alt=media\&token=36641ea7-ae6d-4c5e-9826-3f87f9ec2cfd)

:information\_source:**Support data types**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F2KzFVqYISvSaYlp2EVY2%2Fimage.png?alt=media\&token=833d1b5f-203f-4051-8553-a380c47eccca)

### Create API Contracts

:white\_check\_mark:**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".**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FrHrIp8X9uTni8L0CBNA1%2Fimage.png?alt=media\&token=a44ce0fb-0627-4950-af1f-928a099ee2c0)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FA6RXx90NTt6RTiBxSSRq%2Fimage.png?alt=media\&token=7a6057c2-2053-4d2e-8820-1c25773e09f1)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FFHHNJNTy3KpUH1FYWRpJ%2Fimage.png?alt=media\&token=9b1a1324-ff38-4c33-b0c7-f31218439dd3)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F8C4GwX6qIIZSKCFFqhdh%2Fimage.png?alt=media\&token=6eb0bc0c-d59c-4469-83bb-c49dd7b51324)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FfoDdIsdWn7YXDszQnYem%2Fimage.png?alt=media\&token=c531580d-0fb8-431c-a519-56b1201aef21)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FMWMESY0cwh9jWggPseqM%2Fimage.png?alt=media\&token=3bf3bd21-9adc-45ae-bd1d-0a11dfb26ddd)

:white\_check\_mark:**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.**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2Fz2vMohI2v7bpCVrh8s37%2Fimage.png?alt=media\&token=279609d2-3e7a-484d-a715-203d27290de4)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F4Mi8lzwujMYC33TC3LZf%2Fimage.png?alt=media\&token=fbe29b3d-c362-4b79-9587-5eb84f5f1566)

:information\_source:**Objects, Arrays and Array of Objects allows nesting of parameters inside as illustrated below**

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FxFKtdg5XnI5HmiTJmUKq%2Fimage.png?alt=media&amp;token=57334d59-bb15-457a-9a12-4bd951ea2b83" alt=""><figcaption></figcaption></figure>

:white\_check\_mark:**Select the appropriate Operation from the response body:**

<img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2Fe1Lp6rN5kDAdUlRhlb8d%2Fimage.png?alt=media&amp;token=1fac3afa-a823-430d-a03a-597f3bbdb927" alt="" data-size="original">![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FjJIn7280zs9Dh49MceNH%2Fimage.png?alt=media\&token=455b2f4d-e077-418a-93bb-a716ee28234d)

**Refer to** [**examine schema and simulate payload**](/product-guides/create-api-test.md#examine-schema-and-simulate-payload)

### **Publish API Design**

:warning:Refer [API Standards and Governance](/product-guides/api-standards-and-governance.md)section for OpenAPI validations and mandatory contract structure requirements required by Conektto to publish API designs.

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FwRwYuGB47EbQFaBfO3Du%2Fimage.png?alt=media&amp;token=88f26618-35e4-4aef-bc89-4b51af0a6b18" alt=""><figcaption><p>Conektto API Standards Validation</p></figcaption></figure>

:white\_check\_mark:**Click "Publish" to complete and generate OpenAPI contract**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FDPqtQhb2651dumsJueT8%2Fimage.png?alt=media\&token=7787aeb0-5b89-4578-ad98-8e38607355a9)![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FBjBxMEPCcihFfWPRdJhb%2Fimage.png?alt=media\&token=586999b1-b351-44c9-9bad-b46ed3c5d778)

### **Download API Specification**

:white\_check\_mark:**Your API Specification is now available to download in JSON format**

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FNWs4gf4rbvedgRSnaLIv%2Fimage.png?alt=media\&token=72c982ba-f7a5-4876-b26e-ab3af8226f1b)

### Modify and Republish

Modify as many times you like by editing the parameters, contracts and ![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FQpaRfsS0fRqB6KLUbhWG%2Fimage.png?alt=media\&token=0c1ac77a-67a1-460d-8e57-4eba71f40aea).
