azdAzure API Center adalah layanan yang membantu Anda mengembangkan dan memelihara inventaris terstruktur API organisasi Anda. Dengan API Center, Anda dapat melacak semua API Anda di lokasi terpusat, apa pun jenisnya, tahap siklus hidup, atau lokasi penerapannya. API Center memungkinkan penemuan, penggunaan kembali, dan tata kelola API yang memberdayakan Tim Platform API.
Portal API Center adalah situs web yang memberdayakan pengembang dan pemangku kepentingan untuk menemukan dan berinteraksi dengan API dengan lancar. Implementasi referensi kami pada portal Pusat API memungkinkan tim platform API memberikan pengalaman penemuan dan konsumsi API berbasis web kepada konsumen API.
Implementasi referensi portal API Center menyediakan:
Untuk instans SKU API Center gratis, maksimal 5 API akan ditampilkan di portal API Center terlepas dari berapa banyak API yang ada di API Center.
Untuk SKU standar, tidak ada batasan dan semua API akan ditampilkan.
Sebelum memulai, pastikan Anda telah memenuhi persyaratan berikut:
Anda memiliki dua opsi untuk menerapkan Portal Pusat API yang dihosting sendiri ini:
azd ) untuk penerapan satu langkah aplikasi portal. Opsi ini direkomendasikan untuk proses penerapan yang efisien.azdCATATAN : Anda memerlukan prasyarat tambahan untuk opsi ini
- ✅ CLI Pengembang Azure (
azd)- ✅ Azure CLI
- ✅ GitHub CLI
Garpu repositori ini ke akun GitHub Anda dan kloning.
git clone https://github.com/ < YOUR_GITHUB_ALIAS > /APICenter-Portal-Starter.git Masuk dengan perintah berikut. Kemudian, Anda akan dapat menggunakan azd cli untuk menyediakan dan menyebarkan aplikasi dengan cepat.
# Authenticate with Azure Developer CLI
azd auth login
# Authenticate with Azure CLI
az login Jalankan azd up untuk memprovisikan semua sumber daya ke Azure dan menyebarkan kode ke sumber daya tersebut.
azd up Masukkan nama lingkungan dan pilih subscription dan location yang Anda inginkan. Kemudian, Anda akan diminta memasukkan beberapa nilai lagi:
apiCenterExisted ).apiCenterName , apiCenterRegion dan apiCenterResourceGroupName , jika Anda memilih untuk menggunakan sumber daya pusat API yang ada ( nilai apiCenterExisted ke true ).apiCenterExisted menjadi false ).staticAppLocation untuk instans Azure Static Web Apps. Tunggu beberapa saat hingga penerapan sumber daya selesai.Ada dua skenario:
- Portal dengan Pusat API baru – Anda perlu memberikan
FalsekepadaapiCenterExisteddan membiarkanapiCenterName,apiCenterRegiondanapiCenterResourceGroupNamekosong.- Portal dengan Pusat API yang ada – Anda perlu memberikan
TruekeapiCenterExisteddan meneruskan nilai keapiCenterName,apiCenterRegiondanapiCenterResourceGroupName.
Jika Anda ingin mengintegrasikan alur CI/CD dengan GitHub Actions, Anda dapat menggunakan perintah berikut untuk membuat repositori GitHub dan memasukkan kode ke repositori. Pertama-tama, masuk ke GitHub.
# Authenticate with GitHub CLI
gh auth loginJalankan perintah berikut untuk memperbarui variabel repositori GitHub Anda.
CATATAN : Pastikan Anda telah mem-fork repositori ini ke akun GitHub Anda sebelum menjalankan perintah berikut.
# 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_IDSekarang, Anda siap berangkat! Dorong kode ke repositori GitHub atau jalankan alur kerja Tindakan GitHub secara manual agar portal Anda disebarkan.
Secara default, portal menampilkan semua API dari instans API Center Anda. Anda dapat mengonfigurasi instans portal Anda untuk memfilter API tertentu dengan mengatur properti scopingFilter di file public/config.example menggunakan sintaks kueri OData. Misalnya:
{
"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"
}
Untuk daftar lengkap properti yang dapat difilter, lihat model sumber daya API dataplane.
CATATAN : Anda memerlukan prasyarat tambahan untuk opsi ini
- ✅ Pendaftaran aplikasi yang dikonfigurasi di penyewa Microsoft Entra ID Anda dengan cakupan izin API dan URI Pengalihan yang tepat.
- ✅ Masuk portal diaktifkan dengan penetapan peran yang tepat
Ikuti langkah-langkah berikut untuk menyiapkan lingkungan pengembangan Anda:
Kloning repositori
git clone https://github.com/Azure/APICenter-Portal-Starter.gitBeralih ke cabang utama:
git checkout main Salin atau ganti nama file public/config.example menjadi public/config.json .
Konfigurasikan file public/config.json agar mengarah ke layanan Azure API Center Anda. Berikut contoh konfigurasinya:
{
"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/ "
}
}Instal paket yang diperlukan.
npm installMulai server pengembangan - Perintah ini akan memulai portal dalam mode pengembangan yang berjalan secara lokal:
npm startAzure Static Web Apps adalah layanan yang secara otomatis membangun dan menyebarkan aplikasi web tumpukan penuh ke Azure dari repositori kode. Tutorial ini menggunakan Tindakan GitHub untuk disebarkan ke Azure Static Web Apps.
Untuk melihat portal Pusat API Anda yang berjalan di Aplikasi Web Statis, klik Lihat aplikasi di browser dari tab Gambaran Umum di sumber daya Aplikasi Web Statis yang Anda buat di portal Microsoft Azure.
Lihat pedoman kontribusi untuk mendapatkan ide dan panduan tentang cara meningkatkan template. Terima kasih!
☀️ Kami Senang Mendengar Dari Anda! ☀️
Masukan Anda sangat berharga bagi kami, dan kami mendorong Anda untuk membagikan pemikiran dan saran Anda di bagian Masalah repositori. Anda juga dapat melaporkan bug atau mengirimkan permintaan fitur di sana. Yakinlah, kami akan terus memantau masukan Anda untuk terus meningkatkannya. Meskipun kami berdedikasi untuk memantau masalah ini, harap perhatikan bahwa saluran ini bukan bagian dari Dukungan Layanan Microsoft Azure kami.
Bantuan Dukungan Microsoft Azure terbatas pada penyiapan awal aplikasi Azure Function yang menjalankan mesin linting. Dukungan upaya terbaik diberikan untuk masalah yang disebabkan oleh faktor lingkungan, seperti (namun tidak terbatas pada): platform hosting, lingkungan pengembangan, konfigurasi jaringan.
Jika Anda memerlukan bantuan teknis untuk memperluas mesin linting atau menyempurnakan aturan yang ada, manfaatkan komunitas teknis yang ada seperti Stack Overflow. Kami tidak memberikan dukungan melalui Masalah GitHub.
Kami menyambut dan menghargai kontribusi komunitas.
Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi lebih lanjut lihat FAQ Pedoman Perilaku atau hubungi [email protected] jika ada pertanyaan atau komentar tambahan.
Merek Dagang Proyek ini mungkin berisi merek dagang atau logo untuk proyek, produk, atau layanan. Penggunaan resmi atas merek dagang atau logo Microsoft tunduk dan harus mengikuti Pedoman Merek Dagang & Merek Microsoft. Penggunaan merek dagang atau logo Microsoft dalam versi modifikasi proyek ini tidak boleh menimbulkan kebingungan atau menyiratkan sponsor Microsoft. Segala penggunaan merek dagang atau logo pihak ketiga tunduk pada kebijakan pihak ketiga tersebut.
Pengumpulan Data. Perangkat lunak ini dapat mengumpulkan informasi tentang Anda dan penggunaan Anda atas perangkat lunak dan mengirimkannya ke Microsoft. Microsoft dapat menggunakan informasi ini untuk menyediakan layanan dan meningkatkan produk dan layanan kami. Anda dapat mematikan telemetri seperti yang dijelaskan dalam repositori. Terdapat juga beberapa fitur dalam perangkat lunak yang memungkinkan Anda dan Microsoft mengumpulkan data dari pengguna aplikasi Anda. Jika Anda menggunakan fitur ini, Anda harus mematuhi hukum yang berlaku, termasuk memberikan pemberitahuan yang sesuai kepada pengguna aplikasi Anda bersama dengan salinan pernyataan privasi Microsoft. Pernyataan privasi kami terdapat di https://go.microsoft.com/fwlink/?LinkID=824704. Anda dapat mempelajari lebih lanjut tentang pengumpulan dan penggunaan data dalam dokumentasi bantuan dan pernyataan privasi kami. Penggunaan Anda atas perangkat lunak beroperasi sebagai persetujuan Anda terhadap praktik ini.
MIT
