לאחרונה שחררנו את InterSystems API Manager (IAM), רכיב חדש של InterSystems IRIS Data Platform המספק נראות, בקרה וניהול של תעבורת API באינטרנט על פני תשתית ה-IT.

במאמר זה, אני אראה לך כיצד להגדיר את IAM ולהדגים כמה מהיכולות הרבות הזמינות עבורך עם IAM. InterSystems API Manager מאפשר לך:

• עקוב אחר ה-API, הבן מי משתמש ב-API, אילו ממשקי API הם הפופולריים ביותר, ואילו דורשים שיפור.
• שליטה במי משתמש ב-API והגבלת שימוש ב-API מהגבלות גישה פשוטות להגבלות מבוססות בקשות - יש לך שליטה מותאמת אישית ואתה יכול להגיב במהירות לדפוסי צריכה משתנים של API.
• ממשקי API מאובטחים באמצעות מנגנוני אבטחה מרכזיים כגון OAuth2.0, LDAP או אימות אסימון מפתח.
• הקל על מפתחי צד שלישי וספק להם חווית API מעולה על ידי פתיחת פורטל מפתחים ייעודי.
• הגדל את ה-API והבטח זמן אחזור מינימלי של תגובה.

ניהול API חיוני למעבר לארכיטקטורת SOA או מיקרו-שירותים, המפשט את האינטגרציה בין שירותים בודדים (מיקרו), מה שהופך אותם לזמינים לכל הצרכנים החיצוניים והפנימיים. כתוצאה מכך, ממשקי API חדשים הופכים קלים יותר ליצירה, לתחזוקה ולצריכה.

אם אתה כבר משתמש ב-InterSystems IRIS, אתה יכול להוסיף את אפשרות IAM לרישיון שלך. אפשרות IAM היא בחינם ללקוחות InterSystems IRIS, אך עליך לבקש מפתח רישיון חדש מ-InterSystems כדי להתחיל להשתמש ב-IAM.

אם אינך משתמש עדיין ב-InterSystems IRIS ומתכננת לנסות את InterSystems API Manager, אנא צור קשר עם InterSystems.

תחילת עבודה והתקנה

לקוחות InterSystems יכולים להוריד את הפצת IAM מהאתר WRC סעיף "הפצת תוכנה" והפעל כמיכל Docker. דרישות מערכת מינימליות:

• סַוָר 17.04.0 +.
• דוקר להלחין 1.12.0 +.
• InterSystems IRIS 2019.1.1+.

בתחילה, אתה צריך להוריד את תמונת Docker (חשוב! הארכיון עם WRC הוא לא תמונת Docker, אתה צריך לפרוק אותה, יש תמונת Docker בפנים):

docker load -i iam_image.tar

פקודה זו תהפוך את תמונת IAM לזמינה לשימוש מאוחר יותר בשרת שלך. IAM פועל כמיכל נפרד, כך שתוכל לשנות את קנה המידה שלו באופן עצמאי מ-InterSystems IRIS. הפעלת IAM דורשת גישה ל-InterSystems IRIS כדי להוריד רישיון.

הגדר את InterSystems IRIS:

• הפעל את אפליקציית האינטרנט /api/IAM
• אפשר משתמש IAM
• שנה את סיסמת המשתמש IAM

עכשיו בואו נתחיל את מיכל IAM. בארכיון תמצאו תסריטים iam-setup עבור Windows ו-Unix (ו-Mac). סקריפטים אלה יעזרו לך להגדיר את משתני הסביבה בצורה נכונה, ויאפשרו לקונטיינר IAM ליצור חיבור עם InterSystems IRIS. הנה דוגמה לסקריפט הפועל ב-Mac:

source ./iam-setup.sh 
Welcome to the InterSystems IRIS and InterSystems API Manager (IAM) setup script.
This script sets the ISC_IRIS_URL environment variable that is used by the IAM container to get the IAM license key from InterSystems IRIS.
Enter the full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
Enter the IP address for your InterSystems IRIS instance. The IP address has to be accessible from within the IAM container, therefore, do not use "localhost" or "127.0.0.1" if IRIS is running on your local machine. Instead use the public IP address of your local machine. If IRIS is running in a container, use the public IP address of the host environment, not the IP address of the IRIS container. xxx.xxx.xxx.xxx               
Enter the web server port for your InterSystems IRIS instance: 52773
Enter the password for the IAM user for your InterSystems IRIS instance: 
Re-enter your password: 
Your inputs are:
Full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
IP address for your InterSystems IRIS instance: xxx.xxx.xxx.xxx
Web server port for your InterSystems IRIS instance: 52773
Would you like to continue with these inputs (y/n)? y
Getting IAM license using your inputs...
Successfully got IAM license!
The ISC_IRIS_URL environment variable was set to: http://IAM:****************@xxx.xxx.xxx.xxx:52773/api/iam/license
WARNING: The environment variable is set for this shell only!
To start the services, run the following command in the top level directory: docker-compose up -d
To stop the services, run the following command in the top level directory: docker-compose down
URL for the IAM Manager portal: http://localhost:8002

כפי שאתה יכול לראות, שם התמונה המלא, כתובת ה-IP, יציאת InterSystems IRIS והסיסמה עבור משתמש IAM הם כל מה שאתה צריך כדי להתחיל.

במקום להריץ סקריפט, אתה יכול להגדיר משתני סביבה באופן ידני:

ISC_IAM_IMAGE=intersystems/iam:0.34-1-1
ISC_IRIS_URL=http://IAM:<PASS>@<IP>:<PORT>/api/iam/license

הפעלה

עכשיו בואו נפעיל את IAM על ידי הפעלת הפקודה:

docker-compose up -d

פקודה זו מארגנת את הקונטיינרים של IAM ומבטיחה שהכל פועל כהלכה. סטטוס הקונטיינרים נבדק באמצעות הפקודה:

docker ps

פתח את ממשק הניהול בדפדפן שלך localhost:8002.

זה ריק לעת עתה כי זה צומת חדש לגמרי. בואו נשנה את זה. IAM תומך ברעיון של סביבות עבודה לחלוקת ממשקי API למודולים ו/או פקודות. עבור אל סביבת העבודה "ברירת המחדל" בה נשתמש עבור הניסויים שלנו.

מספר הבקשות עבור סביבת עבודה זו עדיין אפס, אך תקבל מושג על המושגים הבסיסיים של IAM בתפריט משמאל. שני המרכיבים הראשונים: שירותים ומסלולים הם החשובים ביותר:

• שירות הוא ה-API אליו אנו רוצים לספק גישה לצרכנים. לפיכך, ה-REST API ב-InterSystems IRIS הוא שירות, כמו למשל, ה-API של Google אם אתה רוצה להשתמש בו.
• המסלול מחליט לאיזה שירות יש להעביר בקשות נכנסות. לכל מסלול יש מערכת ספציפית של תנאים, ואם הם מתקיימים, הבקשה נשלחת לשירות המתאים. לדוגמה, נתיב יכול להתאים ל-IP, תחום השולח, שיטות HTTP, חלקים של URI או שילוב של דוגמאות אלו.

שירות

בואו ניצור שירות InterSystems IRIS, עם הערכים הבאים:

שדה
ערך
תיאור

שם
איריס
שם השירות

המארח
IP
מארח שרת IRIS של InterSystems או ip

נמל
52773
יציאת אינטרנט לשרת InterSystems IRIS

נתיב
/api/atelier
שביל שורש

פרוטוקול
http
פרוטוקול

השאר את הערכים הנותרים כברירת מחדל. לחץ על הכפתור Create ורשום את המזהה של השירות שנוצר.

מסלול

עכשיו בואו ניצור מסלול:

שדה
ערך
תיאור

נתיב
/api/atelier
שביל שורש

פרוטוקול
http
פרוטוקול

service.id
מדריך מ-3
שירות (מזהה מהשלב הקודם)

השאר את הערכים הנותרים כברירת מחדל. לחץ על הכפתור Create ורשום את המזהה של המסלול שנוצר. כברירת מחדל, IAM מאזין לבקשות נכנסות ביציאה 8000. כעת בקשות שנשלחות אל http://localhost:8000 ומתחיל עם /api/atelier מנותבים מחדש אל InterSystems IRIS.

בדיקה

בוא ננסה ליצור בקשה בלקוח REST (אני משתמש דוור).

בוא נשלח בקשת GET אל http://localhost:8000/api/atelier/ (אל תשכח / בסוף) וקבל תשובה מ-InterSystems IRIS. כל בקשה עוברת דרך IAM אשר אוספת מדדים:

• קוד מצב HTTP.
• לְעַכֵּב.
• ניטור (אם מוגדר).

הגשתי עוד כמה בקשות (כולל שתי בקשות לנקודות קצה לא קיימות כמו /api/atelier/est/), התוצאות נראות מיד בלוח המחוונים:

עבודה עם תוספים

כעת, לאחר שהוגדר מסלול, אנו יכולים לנהל את ה-API שלנו. אנחנו יכולים להוסיף תכונות שישלימו את השירות שלנו.

הדרך הנפוצה ביותר לשנות את ההתנהגות של API היא להוסיף תוסף. תוספים מבודדים פונקציונליות אינדיבידואלית וניתן לחבר אותם ל-IAM באופן גלובלי או רק לישויות בודדות, כגון משתמש (קבוצת משתמשים), שירות או מסלול. נתחיל בהוספת תוסף הגבלת התעריפים למסלול. כדי ליצור חיבור בין התוסף למסלול, אנחנו צריכים מזהה ייחודי (ID) של המסלול.

הגבלת מספר הבקשות

לחץ על תוספים בתפריט סרגל הצד השמאלי. אתה יכול לראות את כל התוספים הפעילים במסך זה, אך מכיוון ששרת IAM זה חדש, אין עדיין תוספים פעילים. אז המשך לשלב הבא על ידי לחיצה על "תוסף חדש".

התוסף שאנו צריכים נמצא בקטגוריית "בקרת תנועה" ונקרא "הגבלת תעריף". בחר בו. יש לא מעט הגדרות שאתה יכול להגדיר כאן, אבל אכפת לנו רק משני שדות:

שדה
ערך
תיאור

route_id
ID
מזהה מסלול

config.minute
5
מספר בקשות לדקה

זה הכל. התוסף מוגדר ופעיל. שימו לב שאנו יכולים לבחור מרווחי זמן שונים, כגון דקה, שעה או יום. ניתן לשלב את ההגדרות (לדוגמה, 1000 בקשות לשעה ובמקביל 100 בקשות לדקה). בחרתי דקות כי זה מקל על בדיקת הפונקציונליות של התוסף.

אם תשלח שוב את אותה בקשה ב-Postman, תראה שהתגובה מוחזרת עם 2 כותרות נוספות:

• XRateLimit-Limit-דקה: 5
• XRateLimit-דקה שנותרה: 4

זה אומר ללקוח שהוא יכול להגיש עד 5 בקשות לדקה ויכול לבצע 4 בקשות נוספות במשבצת הזמן הנוכחית.

אם תגיש את אותה בקשה שוב ושוב, בסופו של דבר תיגמר לך המכסה הזמינה ובמקום זאת תקבל קוד סטטוס HTTP של 429 עם גוף התגובה הבא:

המתן דקה ותוכל להגיש שוב בקשות.

זהו מנגנון נוח המאפשר לך:

• הגן על הקצה האחורי מפני עליות עומס.
• ספר ללקוחות כמה בקשות הם יכולים להגיש.
• ייצר רווח מה-API.

אתה יכול להגדיר ערכים עבור מרווחי זמן שונים ובכך להחליק את תעבורת ה-API על פני פרק זמן מסוים. נניח שאתה מאפשר 600 בקשות לשעה במסלול מסוים. בממוצע יש 10 בקשות לדקה. אבל שום דבר לא מונע מהלקוח להשלים את כל 600 הבקשות בדקה הראשונה של השעה. אולי זה מה שאתה צריך. ייתכן שתרצה להשיג עומס אחיד יותר במהלך שעה. על ידי הגדרת ערך השדה config.minute ערך של 20 מבטיח שהמשתמשים שלך לא יבצעו יותר מ-20 בקשות לדקה ו-600 בקשות לשעה. זה מאפשר עליות קטנות במרווח של דקה אחת בהשוואה לזרימה ממוצעת מלאה של 10 בקשות לדקה, אך המשתמשים לא יכולים להשתמש במכסה השעתית למשך דקה אחת. כעת הם יצטרכו לפחות 30 דקות כדי להשתמש בכל הבקשות שלהם. לקוחות יקבלו כותרות נוספות עבור כל מרווח זמן שצוין, לדוגמה:

כותרת HTTP
ערך

X-RateLimit-Limit-שעה
600

X-RateLimit-שעה שנותרה
595

X-RateLimit-Limit-דקה
20

X-RateLimit-דקה שנותרה
16

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

ממצאים

אני אסיים כאן, אני חושב שיש מספיק חומר למאמר הראשון על InterSystems API Manager. השתמשנו רק באחד מתוך למעלה מ-40 תוספים. יש עוד הרבה דברים מעניינים שאתה יכול לעשות עם IAM:

• הוסף מנגנון אימות מרכזי עבור כל ממשקי ה-API שלך.
• הגדל את העומס באמצעות מאזן עומסים על פני מספר שירותים.
• הוסף פונקציונליות חדשה ותיקוני באגים לקהל המבחן לפני עדכון מלא.
• ספק למפתחים פנימיים וחיצוניים פורטל אינטרנט ייעודי המתעד את כל ממשקי ה-API.
• מטמון בקשות להפחתת זמן התגובה ולהפחתת העומס על הקצה האחורי של המערכת.

תזכור

• ידיעה לתקשורת
• סרטון היכרות
• סרטון מפורט יותר
• רשומות
• הגדרת מאזן עומסים

Webinar

אנו מזמינים אתכם לסמינר המקוון "ניהול API עם InterSystems API Management", שיתקיים ב-21 בנובמבר בשעה 10:00 שעון מוסקבה (GMT+3).
InterSystems API Manager (IAM) הוא רכיב חדש של InterSystems IRIS Data Platform המספק ניטור, בקרה וניהול של תעבורה אל/מ ממשקי API באינטרנט בתוך תשתית ה-IT. בסמינר המקוון נדגים את יכולות המפתח של InterSystems API Management:

• כלי ניטור תעבורת API.
• בקרות תעבורה של API, כולל בקרת רוחב פס, הגבלת מספר קריאות API, שמירה על רשימות של רשימות מותרות ודחויות של כתובות IP וכו'.
• כלי תצורת אבטחת API.
• פורטל מפתחים לפרסום תיעוד API אינטראקטיבי.
• נקודת גישה יחידה ל-API.

הוובינר מיועד לאדריכלים, מפתחים ומנהלי מערכות.

נדרשת הרשמה!

מקור: www.habr.com