APICenter พอร์ทัลเริ่มต้น

โฮสต์พอร์ทัล Azure API Center ของคุณด้วยตนเอง

ภาพรวม

• Azure API Center คืออะไร
• พอร์ทัล Azure API Center คืออะไร
• ข้อกำหนดเบื้องต้น
• เริ่มต้นอย่างรวดเร็ว
  • การปรับใช้อัตโนมัติโดยใช้ azd
  • รันพอร์ทัลภายในเครื่อง
  • การปรับใช้ด้วยตนเองกับ Azure Static Web Apps
• มีส่วนร่วม
• ข้อบกพร่อง & ปัญหา & ข้อเสนอแนะ
• หลักจรรยาบรรณ
• ประกาศเกี่ยวกับเครื่องหมายการค้า
• การวัดและส่งข้อมูลทางไกล
• ใบอนุญาต

พอร์ทัล Azure API Center คืออะไร

Azure API Center เป็นบริการที่ช่วยคุณพัฒนาและบำรุงรักษาสินค้าคงคลังที่มีโครงสร้างของ API ขององค์กรของคุณ ด้วย API Center คุณสามารถติดตาม API ทั้งหมดของคุณในตำแหน่งส่วนกลาง โดยไม่คำนึงถึงประเภท ระยะวงจรการใช้งาน หรือตำแหน่งการติดตั้งใช้งาน API Center ช่วยให้สามารถค้นพบ API นำมาใช้ซ้ำ และการกำกับดูแลที่เสริมศักยภาพให้กับทีมแพลตฟอร์ม API

พอร์ทัลศูนย์ Azure API

พอร์ทัล API Center เป็นเว็บไซต์ที่ช่วยให้นักพัฒนาและผู้มีส่วนได้ส่วนเสียสามารถค้นพบและมีส่วนร่วมกับ API ได้อย่างราบรื่น การใช้งานอ้างอิงของเราในพอร์ทัล API Center ช่วยให้ทีมแพลตฟอร์ม API สามารถมอบประสบการณ์การค้นพบและการใช้ API บนเว็บแก่ผู้บริโภค API

การใช้งานอ้างอิงพอร์ทัล API Center ให้:

• กรอบงานสำหรับการเผยแพร่และการบำรุงรักษาพอร์ทัล API ที่ลูกค้าจัดการ
• แพลตฟอร์มพอร์ทัลที่ลูกค้าสามารถปรับเปลี่ยนหรือขยายให้ตรงตามความต้องการได้
• ความยืดหยุ่นในการโฮสต์บนโครงสร้างพื้นฐานที่แตกต่างกัน รวมถึงการปรับใช้กับ Azure Static Web Apps หรือ Azure App Service

ข้อจำกัด

สำหรับอินสแตนซ์ SKU API Center ฟรี จะมีการแสดง API สูงสุด 5 รายการในพอร์ทัล API Center ไม่ว่า API จะมีจำนวนเท่าใดใน API Center

สำหรับ SKU มาตรฐาน ไม่มีการจำกัดและ API ทั้งหมดจะแสดง

ข้อกำหนดเบื้องต้น

ก่อนที่คุณจะเริ่มต้น ตรวจสอบให้แน่ใจว่าคุณได้ปฏิบัติตามข้อกำหนดต่อไปนี้:

1. ✅ คุณได้ติดตั้ง Node.js และ npm เวอร์ชันล่าสุดแล้ว
2. ✅แพ็คเกจไวต์.

เริ่มต้นอย่างรวดเร็ว

คุณมีสองตัวเลือกในการปรับใช้พอร์ทัลศูนย์ API ที่โฮสต์เองนี้:

• การปรับใช้อัตโนมัติ – ใช้ Azure Developer CLI ( azd ) สำหรับการปรับใช้แอปพอร์ทัลในขั้นตอนเดียว แนะนำให้ใช้ตัวเลือกนี้สำหรับกระบวนการปรับใช้ที่มีความคล่องตัว
• การปรับใช้ด้วยตนเอง – ทำตามคำแนะนำทีละขั้นตอนเพื่อปรับใช้แอปฟังก์ชัน Azure และกำหนดค่าการสมัครรับเหตุการณ์ แนะนำให้ใช้ตัวเลือกนี้หากคุณต้องการปรับใช้และจัดการทรัพยากรด้วยตนเอง

การปรับใช้อัตโนมัติโดยใช้ azd

หมายเหตุ : คุณจะต้องมีข้อกำหนดเบื้องต้นเพิ่มเติมสำหรับตัวเลือกนี้

• ✅ Azure Developer CLI ( azd )
• ✅ Azure CLI
• ✅ GitHub CLI

1. แยกที่เก็บนี้ไปยังบัญชี GitHub ของคุณแล้วโคลนมัน

   git clone https://github.com/ < YOUR_GITHUB_ALIAS > /APICenter-Portal-Starter.git

2. เข้าสู่ระบบด้วยคำสั่งต่อไปนี้ จากนั้น คุณจะสามารถใช้ azd cli เพื่อจัดเตรียมและปรับใช้แอปพลิเคชันได้อย่างรวดเร็ว

    # Authenticate with Azure Developer CLI
   azd auth login
   
   # Authenticate with Azure CLI
   az login

3. เรียกใช้ azd up เพื่อจัดเตรียมทรัพยากรทั้งหมดให้กับ Azure และปรับใช้โค้ดกับทรัพยากรเหล่านั้น

   azd up

   ป้อนชื่อสภาพแวดล้อมและเลือก subscription และ location ที่คุณต้องการ จากนั้นคุณจะถูกขอให้ป้อนค่าเพิ่มเติมสองสามค่า:

   1. เลือกว่าจะใช้อินสแตนซ์ API Center ที่มีอยู่หรือไม่ ( apiCenterExisted )
   2. ส่งค่าสำหรับ apiCenterName , apiCenterRegion และ apiCenterResourceGroupName หากคุณเลือกใช้ทรัพยากรศูนย์ API ที่มีอยู่ (ค่า apiCenterExisted เป็น true )
   3. ปล่อยว่างไว้หากคุณเลือกสร้างทรัพยากรศูนย์ API ใหม่ ( ค่า apiCenterExisted เป็น false )
   4. ส่งผ่านค่า staticAppLocation สำหรับอินสแตนซ์ Azure Static Web Apps รอสักครู่เพื่อให้การปรับใช้ทรัพยากรเสร็จสิ้น

   มีสองสถานการณ์:

   1. พอร์ทัลที่มี API Center ใหม่ - คุณต้องระบุ False ให้กับ apiCenterExisted และปล่อย apiCenterName , apiCenterRegion และ apiCenterResourceGroupName ว่างไว้
   2. พอร์ทัลที่มี API Center ที่มีอยู่ – คุณต้องให้ True แก่ apiCenterExisted และส่งค่าไปยัง apiCenterName , apiCenterRegion และ apiCenterResourceGroupName

4. หากคุณต้องการรวมไปป์ไลน์ CI/CD เข้ากับ GitHub Actions คุณสามารถใช้คำสั่งต่อไปนี้เพื่อสร้างพื้นที่เก็บข้อมูล GitHub และพุชโค้ดไปยังพื้นที่เก็บข้อมูล ก่อนอื่น เข้าสู่ระบบ GitHub

    # Authenticate with GitHub CLI
   gh auth login

5. เรียกใช้คำสั่งต่อไปนี้เพื่ออัปเดตตัวแปรที่เก็บ GitHub ของคุณ

   หมายเหตุ : ตรวจสอบให้แน่ใจว่าคุณได้แยกพื้นที่เก็บข้อมูลนี้ไปยังบัญชี GitHub ของคุณก่อนที่จะรันคำสั่งต่อไปนี้

    # Bash
   AZURE_CLIENT_ID= $( ./infra/scripts/get-azdvariable.sh --key AZURE_CLIENT_ID )
   azd pipeline config --principal-id $AZURE_CLIENT_ID
   
   # PowerShell
   $AZURE_CLIENT_ID = $( ./infra/scripts/Get-AzdVariable.ps1 -Key AZURE_CLIENT_ID )
   azd pipeline config --principal-id $AZURE_CLIENT_ID

6. ตอนนี้คุณก็พร้อมแล้ว! พุชโค้ดไปยังที่เก็บ GitHub หรือรันเวิร์กโฟลว์ GitHub Actions ด้วยตนเองเพื่อปรับใช้พอร์ทัลของคุณ

กำหนดค่าตัวกรองการกำหนดขอบเขต

ตามค่าเริ่มต้น พอร์ทัลจะแสดง API ทั้งหมดจากอินสแตนซ์ API Center ของคุณ คุณสามารถกำหนดค่าอินสแตนซ์พอร์ทัลของคุณเพื่อกรอง API บางตัวออกได้โดยการตั้งค่าคุณสมบัติ scopingFilter ในไฟล์ public/config.example โดยใช้ไวยากรณ์แบบสอบถาม OData ตัวอย่างเช่น:

.data..azure-apicenter.ms/workspaces/default", "title": "API portal", "authentication": { "clientId": "", "tenantId": "", "scopes": ["https://azure-apicenter.net/user_impersonation"], "authority": "https://login.microsoftonline.com/" }, "scopingFilter": "customProperties/compliant eq true" }">

 {
  "dataApiHostName": ".data..azure-apicenter.ms/workspaces/default",
  "title": "API portal",
  "authentication": {
      "clientId": "",
      "tenantId": "",
      "scopes": ["https://azure-apicenter.net/user_impersonation"],
      "authority": "https://login.microsoftonline.com/"
  },
  "scopingFilter": "customProperties/compliant eq true"
}

หากต้องการดูรายการคุณสมบัติที่กรองได้ทั้งหมด โปรดดูโมเดลทรัพยากร Dataplane API

รันพอร์ทัลภายในเครื่อง

หมายเหตุ : คุณจะต้องมีข้อกำหนดเบื้องต้นเพิ่มเติมสำหรับตัวเลือกนี้

• ✅ กำหนดค่าการลงทะเบียนแอปในผู้เช่า Microsoft Entra ID ของคุณด้วยขอบเขตการอนุญาต API ที่ถูกต้องและ URI การเปลี่ยนเส้นทาง
• ✅ เปิดใช้งานการลงชื่อเข้าใช้พอร์ทัลด้วยการกำหนดบทบาทที่ถูกต้อง

ทำตามขั้นตอนเหล่านี้เพื่อตั้งค่าสภาพแวดล้อมการพัฒนาของคุณ:

1. โคลนพื้นที่เก็บข้อมูล

   git clone https://github.com/Azure/APICenter-Portal-Starter.git

2. เปลี่ยนไปใช้สาขาหลัก:

   git checkout main

3. คัดลอกหรือเปลี่ยนชื่อไฟล์ public/config.example เป็น public/config.json

4. กำหนดค่าไฟล์ public/config.json ให้ชี้ไปที่บริการ Azure API Center ของคุณ นี่คือตัวอย่างการกำหนดค่า:

   .data..azure-apicenter.ms/workspaces/default", "title": "API portal", "authentication": { "clientId": "", "tenantId": "", "scopes": ["https://azure-apicenter.net/user_impersonation"], "authority": "https://login.microsoftonline.com/" } }">

   {
     "dataApiHostName" : " .data..azure-apicenter.ms/workspaces/default " ,
     "title" : " API portal " ,
     "authentication" : {
         "clientId" : "  " ,
         "tenantId" : "  " ,
         "scopes" : [ " https://azure-apicenter.net/user_impersonation " ],
         "authority" : " https://login.microsoftonline.com/ "
     }
   }

5. ติดตั้งแพ็คเกจที่จำเป็น

   npm install

6. เริ่มต้นเซิร์ฟเวอร์การพัฒนา - คำสั่งนี้จะเริ่มพอร์ทัลในโหมดการพัฒนาที่ทำงานในเครื่อง:

   npm start

การปรับใช้ด้วยตนเองกับ Azure Static Web Apps

Azure Static Web Apps เป็นบริการที่สร้างและปรับใช้เว็บแอปแบบสแตกเต็มรูปแบบไปยัง Azure โดยอัตโนมัติจากที่เก็บโค้ด บทช่วยสอนนี้ใช้ GitHub Actions เพื่อปรับใช้กับ Azure Static Web Apps

1. สร้าง Static Web App ใหม่
2. เลือก GitHub เป็น แหล่งที่มา
3. เลือก องค์กร GitHub พื้นที่เก็บข้อมูล และสาขา ที่มีพอร์ทัล API Center หมายเหตุ: คุณต้องแยกพื้นที่เก็บข้อมูลพอร์ทัล API Center ไปยังบัญชีส่วนตัวหรือองค์กรของคุณเอง และเลือกพื้นที่เก็บข้อมูลนี้
4. เลือก React เป็น Build Presets
5. ป้อน / เป็น ตำแหน่งของแอป
6. ป้อน dist เป็น ตำแหน่งเอาต์พุต
7. คลิก สร้าง ไฟล์เวิร์กโฟลว์ GitHub จะถูกส่งไปยังพื้นที่เก็บข้อมูลที่เลือกในขั้นตอนที่ #3 และการปรับใช้กับ Static Web App ของคุณด้วย GitHub Actions จะเริ่มต้นขึ้น อาจใช้เวลาถึงห้านาทีจึงจะเห็นการเปลี่ยนแปลงของคุณเผยแพร่

หากต้องการดูพอร์ทัล API Center ของคุณที่ทำงานบน Static Web Apps ให้คลิก ดูแอปในเบราว์เซอร์ จากแท็บ ภาพรวม ในทรัพยากร Static Web App ที่คุณสร้างในพอร์ทัล Azure

มีส่วนร่วม

ดูแนวทางการสนับสนุนสำหรับแนวคิดและคำแนะนำเกี่ยวกับวิธีการปรับปรุงเทมเพลต ขอบคุณ!

ข้อบกพร่อง & ปัญหา & ข้อเสนอแนะ

☀️ เราชอบที่จะได้ยินจากคุณ!

ความคิดเห็นของคุณมีค่าสำหรับเรา และเราขอแนะนำให้คุณแบ่งปันความคิดและข้อเสนอแนะของคุณในส่วน ปัญหา ของพื้นที่เก็บข้อมูล คุณยังสามารถรายงานข้อบกพร่องหรือส่งคำขอคุณสมบัติได้ที่นั่น มั่นใจได้ว่าเราจะคอยติดตามความคิดเห็นของคุณอย่างใกล้ชิดเพื่อปรับปรุงอย่างต่อเนื่อง แม้ว่าเราจะทุ่มเทให้กับการตรวจสอบปัญหาเหล่านี้ โปรดทราบว่าช่องทางนี้ไม่ได้เป็นส่วนหนึ่งของการสนับสนุนบริการ Microsoft Azure ของเรา

ความช่วยเหลือ ด้านการสนับสนุนของ Microsoft Azure นั้นจำกัดอยู่ที่การตั้งค่าเริ่มต้นของแอปฟังก์ชัน Azure ที่รันกลไก Linting การสนับสนุนอย่างดีที่สุดมีให้สำหรับปัญหาที่เกิดจากปัจจัยด้านสิ่งแวดล้อม เช่น (แต่ไม่จำกัดเพียง): แพลตฟอร์มการโฮสต์ สภาพแวดล้อมการพัฒนา การกำหนดค่าเครือข่าย

หากคุณต้องการความช่วยเหลือด้านเทคนิคในการขยายประสิทธิภาพของ Linting Engine หรือปรับปรุงกฎที่มีอยู่ โปรดใช้ประโยชน์จากชุมชนทางเทคนิคที่มีอยู่ เช่น Stack Overflow เราไม่ให้การสนับสนุนผ่านปัญหา GitHub

เรายินดีและชื่นชมการมีส่วนร่วมของชุมชน

หลักจรรยาบรรณ

โครงการนี้ได้นำหลักจรรยาบรรณของ Microsoft Open Source มาใช้ สำหรับข้อมูลเพิ่มเติม โปรดดูคำถามที่พบบ่อยเกี่ยวกับจรรยาบรรณหรือติดต่อ [email protected] หากมีคำถามหรือความคิดเห็นเพิ่มเติม

ประกาศเกี่ยวกับเครื่องหมายการค้า

เครื่องหมายการค้า โครงการนี้อาจมีเครื่องหมายการค้าหรือโลโก้สำหรับโครงการ ผลิตภัณฑ์ หรือบริการ การใช้เครื่องหมายการค้าหรือโลโก้ของ Microsoft โดยได้รับอนุญาตนั้นอยู่ภายใต้และต้องปฏิบัติตามแนวทางเครื่องหมายการค้าและแบรนด์ของ Microsoft การใช้เครื่องหมายการค้าหรือโลโก้ของ Microsoft ในเวอร์ชันแก้ไขของโครงการนี้จะต้องไม่ทำให้เกิดความสับสนหรือบ่งบอกถึงการสนับสนุนของ Microsoft การใช้เครื่องหมายการค้าหรือโลโก้ของบุคคลที่สามจะต้องเป็นไปตามนโยบายของบุคคลที่สามเหล่านั้น

การวัดและส่งข้อมูลทางไกล

การรวบรวมข้อมูล ซอฟต์แวร์อาจรวบรวมข้อมูลเกี่ยวกับคุณและการใช้งานซอฟต์แวร์ของคุณและส่งไปยัง Microsoft Microsoft อาจใช้ข้อมูลนี้เพื่อให้บริการและปรับปรุงผลิตภัณฑ์และบริการของเรา คุณสามารถปิดการวัดและส่งข้อมูลทางไกลตามที่อธิบายไว้ในที่เก็บ นอกจากนี้ยังมีคุณสมบัติบางอย่างในซอฟต์แวร์ที่อาจช่วยให้คุณและ Microsoft สามารถรวบรวมข้อมูลจากผู้ใช้แอปพลิเคชันของคุณได้ หากคุณใช้คุณลักษณะเหล่านี้ คุณจะต้องปฏิบัติตามกฎหมายที่บังคับใช้ รวมถึงการแจ้งประกาศที่เหมาะสมแก่ผู้ใช้แอปพลิเคชันของคุณพร้อมกับสำเนาคำชี้แจงสิทธิส่วนบุคคลของ Microsoft คำชี้แจงสิทธิส่วนบุคคลของเราอยู่ที่https://go.microsoft.com/fwlink/?LinkID=824704 คุณสามารถเรียนรู้เพิ่มเติมเกี่ยวกับการเก็บรวบรวมและการใช้ข้อมูลได้ในเอกสารวิธีใช้และคำชี้แจงสิทธิ์ส่วนบุคคลของเรา การใช้ซอฟต์แวร์ของคุณถือเป็นการยินยอมของคุณต่อแนวทางปฏิบัติเหล่านี้

ใบอนุญาต

เอ็มไอที