Introduction

Importing Custom SDK

The Custom SDK Import feature in Theneo allows users to integrate their own SDKs for use within the platform. This feature currently supports OpenAPI specifications. By adding the x-theneo-endpoint-metadata property to your OpenAPI spec, Theneo will be able to import and utilize your custom SDK in the platform's interface.

Steps for Importing Custom SDK

1

Prepare Your OpenAPI Specification:

Ensure your OpenAPI spec is up to date and reflects the endpoints you wish to use with the Theneo platform.

2

Add Custom SDK Metadata:

Within your OpenAPI spec, add the x-theneo-endpoint-metadata field to the endpoints where you want to use your custom SDK.
Include code examples for supported languages under the examples

Example of Custom SDK Metadata:

or check out this full sample spec

YAML

 "x-theneo-endpoint-metadata": {
          "examples": [
            {
              "title": "Create a Pet",
              "request": {
                "python": "from swagger_petstore_sdk import PetstoreClient\n\n# Python\nclient = PetstoreClient()\nnew_pet = {'name': 'NewPet', 'tag': 'Tag123'}\nresponse = client.create_pet(new_pet)\nprint(response.status_code)",
                "javascript": "import { PetstoreClient } from 'swagger-petstore-sdk';\n\n// JavaScript\nconst client = new PetstoreClient();\nconst newPet = { name: 'NewPet', tag: 'Tag123' };\nconst response = await client.createPet(newPet);\nconsole.log(response.status)"
              }
            }
          ]
        }

3

Import the OpenAPI Spec to Theneo:

After updating your OpenAPI spec, import it into Theneo.
Theneo will read the x-theneo-endpoint-metadata and populate the SDK selection dropdown with your custom SDK options.

Supported Languages

Currently, Theneo supports importing SDK examples written in the following languages:

cURL

Python

Javascript

Go

Java

Csharp

PHP

Ruby

GraphQL

Upcoming Language Support

Theneo plans to expand support to additional languages in the future. Keep an eye on the platform updates for when these become available.

Technical Requirements and Limitations

OpenAPI Specification: Your API must have an OpenAPI specification to use this feature.
Endpoint Metadata: The x-theneo-endpoint-metadata field is necessary for Theneo to recognize and import the SDK properly.
Editor Limitation: Currently, modifications to the x-theneo-endpoint-metadata for the purpose of custom SDK integration cannot be made directly within the Theneo editor. These changes must be made to the OpenAPI spec file before importing it into Theneo.

By adhering to these guidelines, you can effectively document and import your custom SDKs into Theneo, providing a seamless experience for users to interact with your API through the platform.

Sections