Skip to content
Weik.ioDocs
2026.1
Try Weik.io

This page describes Weik.io 2026.1, and the current release is 2026.2. Weik.io 2026.2 docs

OpenApiConnector Configuration

Weik.io 2026.1

Register OpenAPI connectors from packages.

On this page

Registers an OpenAPI connector from a package, making its operations available for use in APIs and integrations.

Schema properties#

Property Type Required Default Description
Name string Yes - Connector name
Description string No - Human-readable description of the connector
Package string Yes - Package identifier (NuGet package name or local path)
Version string No Latest Package version to install
Labels string[] No [] Labels/tags for categorizing the connector

YAML examples#

Basic connector registration#

apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: stripe-connector
spec:
  Name: stripe
  Description: Stripe payment processing connector
  Package: Weikio.Connectors.Stripe
  Version: 1.2.0

Connector with labels#

apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: salesforce-connector
spec:
  Name: salesforce
  Description: Salesforce CRM connector with full API support
  Package: Weikio.Connectors.Salesforce
  Version: 2.1.0
  Labels:
    - crm
    - sales
    - cloud
    - enterprise

Multiple connectors#

apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: github-connector
spec:
  Name: github
  Description: GitHub API connector
  Package: Weikio.Connectors.GitHub
  Labels:
    - git
    - version-control
    - devops
---
apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: slack-connector
spec:
  Name: slack
  Description: Slack messaging and collaboration connector
  Package: Weikio.Connectors.Slack
  Labels:
    - messaging
    - collaboration
    - notifications
---
apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: sendgrid-connector
spec:
  Name: sendgrid
  Description: SendGrid email delivery connector
  Package: Weikio.Connectors.SendGrid
  Labels:
    - email
    - notifications
    - cloud

Latest version connector#

apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: azure-connector
spec:
  Name: azure-storage
  Description: Azure Storage connector for blobs, queues, and tables
  Package: Weikio.Connectors.Azure.Storage
  Labels:
    - azure
    - storage
    - cloud

Local package connector#

apiVersion: weik.io/v1
kind: OpenApiConnector
metadata:
  name: custom-erp-connector
spec:
  Name: custom-erp
  Description: Custom ERP system connector
  Package: ./packages/CustomERP.Connector.1.0.0.nupkg
  Version: 1.0.0
  Labels:
    - erp
    - custom
    - internal

Usage notes#

OpenApiConnector configurations register connectors that provide OpenAPI-based integrations with external services and systems. Connectors expose operations that can be used in APIs and integration flows.

Package sources#

The Package field supports:

  • NuGet package names: Installed from configured NuGet feeds (e.g., Weikio.Connectors.Stripe)
  • Local package paths: Relative or absolute paths to .nupkg files
  • Private package feeds: Packages from private NuGet repositories

Versioning#

The Version field:

  • Specifies exact version: 1.2.0
  • Omit to use the latest available version
  • Use version ranges for flexibility: [1.0.0,2.0.0)

Labels#

Labels help organize and categorize connectors:

  • Use labels for filtering and discovery
  • Common label categories: technology, provider, purpose, domain
  • Labels appear in connector listings and documentation

Connector operations#

Once registered, connector operations become available:

  • In OpenAPI endpoint configurations
  • In integration flow service calls
  • Through the connector API
  • In the platform UI

Discovery#

After registration, list connectors with:

Terminal
weikio connector openapi ls

Best practices#

  • Use descriptive connector names (lowercase, hyphen-separated)
  • Provide clear descriptions explaining connector capabilities
  • Apply consistent labeling across related connectors
  • Pin versions for production deployments
  • Test connectors in development before production deployment
  • Document connector-specific configuration requirements
  • Group related connectors by label
  • Keep connector packages updated for security patches
  • Use semantic versioning for custom connectors

Common connector categories#

Label your connectors by category:

  • CRM: Salesforce, HubSpot, Dynamics
  • Payment: Stripe, PayPal, Square
  • Communication: Slack, Microsoft Teams, Twilio
  • Email: SendGrid, Mailgun, Amazon SES
  • Storage: Azure Storage, AWS S3, Google Cloud Storage
  • Database: PostgreSQL, MongoDB, Redis
  • Analytics: Google Analytics, Mixpanel, Amplitude
  • Development: GitHub, GitLab, Jira

Building custom connectors#

Build custom connectors with the Weik.io connector SDK and package them as NuGet packages. See the Weik.io connector development documentation for details on creating custom connectors.