יצירת מחבר בהתאמה אישית וחיבור

בדף הזה מוסבר איך ליצור מפרט OpenAPI לשירות אינטרנט, ואז ליצור מחבר בהתאמה אישית וחיבור למחבר הזה.

לפני שיוצרים מחבר בהתאמה אישית, צריך ליצור מפרט OpenAPI לשירות האינטרנט.

יצירת מפרט OpenAPI לשירות האינטרנט

מחברים בהתאמה אישית תומכים ב-OpenAPI 3.0. אפשר גם ליצור את המפרט באופן ידני. מידע על מפרטי OpenAPI זמין במאמר מפרטי OpenAPI.

אפשר גם ליצור אוטומטית את מפרט OpenAPI 2.0 באמצעות תוכנת הביניים gin swagger. מידע נוסף זמין במאמר בנושא Gin Swagger. צריך להמיר את מפרט OpenAPI 2.0 למפרט OpenAPI גרסה 3.0 באמצעות Swagger Converter.

דוגמה למפרט OpenAPI.

{
  "openapi": "3.0.0",
  "info": {
    "title": "Go HTTPbin Proxy Service",
    "description": "A simple Go service that proxies requests to httpbin.org, adding custom headers.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080"
    }
  ],
  "paths": {
    "/getData": {
      "get": {
        "summary": "Fetch data from httpbin.org/get",
        "description": "Sends a GET request to httpbin.org/get, including any custom headers.",
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/postData/{id}": {
      "post": {
        "summary": "Post data to httpbin.org/post",
        "description": "Sends a POST request to httpbin.org/post with data, including any custom headers.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"   

                  },
                  "address": {
                    "type": "string"
                  },
                  "gender": {
                    "type": "string"   
                  }
                },
                "required": [
                  "name",
                  "address",
                  "gender"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request body"
          }
        }
      }
    }
  }
}

יצירת מחבר בהתאמה אישית ואימות השירות

צריך ליצור מחבר בהתאמה אישית ואז לאמת את שירות האינטרנט באמצעות שימוש בו בחיבור ב-Application Integration.

לפני שמתחילים

מגדירים Private Service Connect ‏ (PSC) למכונה הווירטואלית הזו ואז יוצרים קובץ מצורף של נקודת קצה.

יצירת מחבר בהתאמה אישית

  1. במסוף, עוברים לדף Application Integration > Custom connectors, ואז בוחרים או יוצרים פרויקט ב- Google Cloud .

    מעבר לדף Custom connectors

  2. לוחצים על יצירת חדש כדי לפתוח את הדף יצירת מחבר בהתאמה אישית.
  3. בקטע פרטי המחבר, מציינים את שדות החובה, כמו שם המחבר ושם התצוגה.בנוסף, מזינים את תרחישי השימוש של המחבר בשדה תיאור.
  4. הגדרת יעד המחבר לגישה לשרת העורפי: מפעילים את האפשרות הזו. כך מוצגים בדף קטעי ההגדרות הנוספים.
  5. חשבון שירות: בוחרים חשבון שירות עם התפקידים הנדרשים.
  6. לוגו: מעלים תמונה לקטגוריה ב-Cloud Storage כדי להשתמש בה כסמל של המחבר.
  7. בקטע Connector Specification (מפרט המחבר), מזינים את כתובת ה-URL הציבורית של מפרט Open API או מעלים את קובץ המפרט לדלי Cloud Storage.
  8. בקטע Connector Destination, מוסיפים את כתובת ה-IP של קובץ הקצה ואת היציאה שבה השירות פועל.
  9. בקטע Connector Authentication, בוחרים באפשרות No Authentication. מחברי Marketplace לא תומכים בסוגי אימות.
  10. בקטע Backend Variables (משתני קצה עורפי), מוסיפים את המשתנים שרוצים להזין כקלט בזמן יצירת החיבור. המשתנים האלה מופיעים בדף ליצירת קישור ונשלחים בכל קריאה ל-API שמתבצעת לשירות. בקטע הזה צריך להוסיף את הערכים שלא ישתנו באמצעות ממשקי API, כמו פרטי כניסה של צד שלישי לשרת העורפי.
  11. יוצרים את המחבר המותאם אישית. חשוב לוודא שציינתם לוגו ותיארתם את תרחישי השימוש במחבר המותאם אישית.

יצירת חיבור

אחרי שיוצרים את המחבר המותאם אישית, יוצרים את החיבור למחבר הזה.

  1. לוחצים על יצירת חדש כדי לפתוח את הדף יצירת חיבור.
  2. בוחרים את המחבר המותאם אישית שיצרתם.
  3. מוסיפים ערכים לשדות החיבור שהגדרתם.
  4. יוצרים את החיבור.

אימות השירות

כדי לאמת את השירות, יוצרים שילוב חדש.

  1. במסוף Google Cloud, עוברים לדף Application Integration ויוצרים אינטגרציה.
  2. מוסיפים טריגר API ומשימת מחבר.
  3. מגדירים את משימת המחבר כך שתשתמש בחיבור שנוצר בשלב הקודם. מוסיפים את הכלי למיפוי נתונים אם צריך.
  4. מגדירים את connectorInputPayload עבור המחבר בהתאם לסכימה.
  5. מריצים את השילוב כדי לוודא שהחיבור פועל.

אם האינטגרציה פועלת בהצלחה ומחזירה את התגובה הצפויה, שירות האינטרנט מאומת.

המאמרים הבאים