Generate a connector¶ Generate a connector from an OpenAPI definition¶ This document explains how to generate a connector from an OpenAPI definition using WSO2 Integrator: MI for VSCode Extension. By using an OpenAPI definition, users can automatically create a connector that enables seamless integration with RESTful APIs. The connector will be added to your project and you can use it in your integration flows. When you share your Integration Project with others, the connector will be included in the project. Follow the below steps to generate a connector using the WSO2 Integrator: MI for VS Code extension (MI for VS Code). Launch Visual Studio Code with the MI for VS Code extension installed. Info Follow the Install WSO2 Integrator: MI for VS Code documentation for a complete installation guide. Create a new integration project. Click Create New Project on WSO2 Integrator: MI Project Explorer. For more options to create a new integration project, see Create an Integration Project. Navigate to the Project Overview page. Click on Add artifact. Click + View More under Create an Integration. Select Connections under Other Artifacts to open the Connector Store form. Click Import Connector. Select Import Using OpenAPI method and click on Select Location to upload the OpenAPI definition file. After uploading the file, click Import. Tip You can download a sample OpenAPI definition file from here. If the OpenAPI definition is valid, the connector will be generated and added to the project. You can view the generated connection type in the Connections. To use the connector operations, you can create an integration artifact (such as API and sequence) and add it from the Mediator Palette. Generate a gRPC connector from a Proto definition¶ This section explains how to generate a gRPC connector from a .proto file using the WSO2 Integrator: MI Connector Generator tool. The gRPC connector enables seamless communication between services, facilitating integration with systems that expose gRPC APIs. By utilizing a .proto file, which defines the service and message structure, the connector is automatically generated, allowing you to implement a fully functional gRPC client in your integration. Prerequisites¶ Before you begin, ensure you have the following: Java Development Kit (JDK) 8 or later Apache Maven 3.6.x or higher Steps to generate the connector¶ There are two ways of generating a gRPC connector from a .proto file: Using the WSO2 Integrator: MI for VS Code extension: This method allows you to generate a connector directly from the VS Code IDE. Using the WSO2 MI Connector Tooling: This method involves using a command-line tool to generate the connector from a .proto file. Option 01: Using the WSO2 Integrator: MI for VS Code extension¶ Follow the steps below to generate the gRPC connector: Launch Visual Studio Code with the MI for VS Code extension installed. Info Follow the Install WSO2 Integrator: MI for VS Code documentation for a complete installation guide. Create a new integration project. Click Create New Project on WSO2 Integrator: MI Project Explorer. For more options to create a new integration project, see Create an Integration Project. Navigate to the Project Overview page. Add a new artifact by clicking on Add artifact. Click on + View More under Create an Integration. Select Connections under Other Artifacts to open the Connector Store form. Click on the For gRPC (Proto) Then select a location for the .proto file and click the import If the given proto file is valid, You can view the generated connection type in the Connections. To use the connector operations, you can create an integration artifact (such as API and sequence) and add it from the Mediator Palette. Option 02: Using the WSO2 MI Connector Tooling¶ Follow the steps below to generate the gRPC connector: Fork the MI connector tooling repository Fork the esb-connector-tooling repository. Build the project using maven Navigate to your project directory (<PROJECT_HOME>/) and build the project using Maven: mvn clean install Locate the tool Once built, the tool will be packaged as a zip file: mi-connector-generator-{version}.zip. You can find this file in the <PROJECT_HOME>/target directory. Extract the tool Extract the mi-connector-generator-{version}.zip file to your preferred location. Run the connector generator Navigate to the extracted folder and go to the bin directory. For macOS/Linux: Use generate.sh: ./generator <proto-file> <output-directory> [miVersion] For Windows: Use generate.bat: generator.bat <proto-file> <output-directory> [miVersion] Replace: <proto-file> with the path to your .proto file. <output-directory> with the path where you want the connector to be generated. [miVersion] with your specific WSO2 Integrator: MI version. Example command¶ For macOS/Linux: ./generator /path/to/order-service.proto /path/to/output-directory 4.7.0 For Windows: generator.bat C:\path\to\order-service.proto C:\path\to\output-directory 4.7.0 By following these steps, you can generate a fully functional gRPC connector from a .proto file, enabling seamless integration with gRPC-based services in WSO2 Integrator: MI. Steps to import generated connector¶ Navigate to the Mediator Palette page Select the Add Module under the Mediator Palette. Select Import Module Select Location to upload the generated connector. After providing the generated connector zip file, click Import You can view the connector type in the Connections To use the connector operations, you can create an integration artifact (such as API and sequence) and add it from the Mediator Palette. Examples of using the generated connector¶ Order management integration example¶ This example demonstrates how to integrate with the OrderService gRPC API to handle the lifecycle of an order in a retail system—from creation to retrieval and updates. This API facilitates seamless backend communication for e-commerce platforms, inventory systems, and similar applications. Create a new integration project in WSO2 Integrator: MI for VS Code, see Create an Integration Project. Create a new sequence or API artifact within your integration project, see Create Sequence. From the Mediator Palette, select the orderservice connector that was generated from the order-service.proto file using above one of options. Create a connection by filling in the form with the required authentication details. Add the CreateOrder operation to your sequence or API. Provide the necessary input as a JSON object that matches the input message defined in the .proto file. Ensure the response is set to overwrite the payload. Request message for creating an order. message CreateOrderRequest { string customer_id = 1; string product_id = 2; int32 quantity = 3; float price = 4; } JSON values for the above message type { "customer_id": "cust123", "product_id": "prod789", "quantity": 2, "price": 299.99 } Similarly, you can use the GetOrder operation to retrieve order details by supplying the order_id. Again, make sure the response overwrites the payload. { "order_id": "order456" } Optionally, add the UpdateOrder operation to modify existing orders by providing the order ID and updated details. Add any response handling logic needed to process the output from the gRPC calls at the end of your sequence or API. Advanced data mapping example with order management integration¶ This example shows how to use the generated gRPC connector alongside the Data Mapper mediator in WSO2 Integrator: MI to perform advanced data mapping and transformation. Follow steps 1–4 above to set up your integration project and connection. Imagine a scenario where you have a complex JSON object with 30 fields from another data source, and you need to map it to the CreateOrder request message defined in the order-service.proto file. You can use the Data Mapper mediator to transform this complex structure into the expected input for your gRPC call. Input JSON Example: This is the complex JSON object you might receive from another service or data source. { "customer_id": "cust123", "product_id": "prod789", "quantity": 2, "price": 299.99, "shipping_address": { "street": "123 Main St", "city": "Springfield", "state": "IL", "zip_code": "62701" }, "billing_address": { "street": "456 Elm St", "city": "Springfield", "state": "IL", "zip_code": "62701" } // ... other fields } - Data Mapping: Use the Data Mapper mediator to map the complex JSON structure to the CreateOrderRequest message. The mapping can be done visually in the WSO2 Integrator: MI for VS Code. With the Data Mapper, you can add expression conditions to your mappings, allowing you to transform or filter data as needed. For example, you can set conditions to map certain fields only when specific criteria are met, or format data before sending it to the gRPC service. Data Mapper sourcecode import * as dmUtils from "./dm-utils"; /* * title : "root", * inputType : "JSON", */ interface Root { order: { metadata: { order_id: string created_at: string status: string priority: string } customer_info: { customer_id: string name: string email: string phone: string loyalty_points: number } shipping: { address: { line1: string line2: string city: string state: string zip_code: string country: string } method: string tracking_number: string estimated_delivery: string } billing: { payment_method: string transaction_id: string payment_status: string billing_address_same_as_shipping: boolean } product: { product_id: string name: string quantity: number price: number category: string in_stock: boolean } summary: { subtotal: number discount: number tax: number shipping_fee: number total: number } flags: { is_gift: boolean gift_message: string requires_signature: boolean } custom_data: { tags: string[] comments: string custom_reference: string } } } /* * title : "Order", * outputType : "JSON", */ interface OutputOrder { order_id?: string customer_id: string product_id: string quantity: number price: number } interface Orders { orderId: string } /** * functionName : map_S_root_S_Order * inputVariable : inputroot */ export function mapFunction(input: Root): OutputOrder { return { customer_id: input.order.customer_info.customer_id, product_id: input.order.product.product_id, order_id: input.order.metadata.order_id, quantity: (input.order.product.quantity == 0) ? 5 : input.order.product.quantity, price: input.order.product.price * 300 } } This approach makes it easy to work with large or differently structured input payloads, ensuring they conform to your gRPC request messages. Note The gRPC Connector Generator does not yet handle: Streaming RPCs : server, client, or bidirectional streams Custom .proto options: e.g., deadline, multiple package imports, or any other non-standard option fields Specific data types: oneof unions, enum values, map fields, and deeply nested complex structures For the full list of features the tool does support, see the gRPC generator tool specification guide.