Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Jelajahi konsep utama Azure API Center, yang memungkinkan Anda melacak API di lokasi terpusat untuk penemuan, penggunaan kembali, dan tata kelola.
Model data
Entitas utama dalam konfigurasi Azure API Center mencakup API Anda dan versi, definisi, dan penyebarannya. Lingkungan runtime yang mungkin untuk setiap API dan metadata deskriptif melengkapi konfigurasi.
Diagram berikut menunjukkan entitas utama dan bagaimana mereka berhubungan satu sama lain.
API
Entitas logis tingkat atas di Azure API Center, API mewakili API dunia nyata apa pun yang ingin Anda lacak. Pusat API dapat mencakup API jenis apa pun, termasuk REST, GraphQL, gRPC, SOAP, WebSocket, dan Webhook.
Anda dapat mengelola API di inventori oleh solusi manajemen API apa pun. Misalnya, gunakan Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management, atau platform lain. API yang diwakili di Azure API Center juga dapat tidak dikelola.
Manajer program API atau administrator TI dapat membuat dan mengelola inventaris API di Azure API Center. Azure API Center juga menyertakan fitur bagi pengembang API untuk mendaftarkan definisi API langsung dari lingkungan pengembangannya, seperti Visual Studio Code atau alur CI/CD.
versi API
Penerapan versi API adalah praktik mengelola perubahan pada API dan memastikan perubahan dilakukan tanpa mengganggu klien. API dapat memiliki beberapa versi di seluruh tahap siklus hidup, masing-masing selaras dengan perubahan API tertentu. Beberapa versi mungkin memperkenalkan perubahan besar atau perubahan signifikan, sementara versi lainnya menambahkan peningkatan kecil. Versi API dapat berada pada tahap siklus hidup apa pun dari desain, hingga pratinjau, produksi, atau tidak digunakan lagi.
Definisi API
Harus ada setidaknya satu definisi untuk setiap versi API, seperti definisi OpenAPI untuk REST API. Azure API Center memungkinkan file definisi API apa pun yang diformat sebagai teks (YAML, JSON, Markdown, dan sebagainya). Anda dapat mengunggah definisi OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL, dan WADL, antara lain.
Untuk membantu tata kelola API, Azure API Center menyediakan kemampuan linting untuk menganalisis definisi API untuk kualitas dan kepatuhan terhadap standar organisasi.
Lingkungan
Lingkungan mewakili lokasi tempat runtime API dapat disebarkan seperti layanan Azure API Management atau layanan Apigee API Management. Anda juga dapat menyebarkan ke layanan komputasi seperti kluster Kubernetes, Aplikasi Web, atau aplikasi Azure Functions. Setiap lingkungan selaras dengan tahap siklus hidup seperti pengembangan, pengujian, penahapan, atau produksi. Lingkungan mungkin juga menyertakan informasi tentang portal pengembang atau antarmuka manajemen.
Catatan
Gunakan Azure API Center untuk melacak salah satu lingkungan runtime API Anda, terlepas dari apakah mereka dihosting di infrastruktur Azure. Lingkungan ini tidak sama dengan Lingkungan Penyebaran Azure.
Penyebaran
Penyebaran adalah lokasi (alamat) tempat pengguna dapat mengakses API. API dapat memiliki beberapa penyebaran, seperti lingkungan atau wilayah penahapan yang berbeda. Misalnya, API dapat memiliki satu penyebaran di lingkungan penahapan internal dan satu detik di lingkungan produksi. Setiap penyebaran dikaitkan dengan definisi API tertentu.
Metadata
Di Azure API Center, atur API, penyebaran, dan entitas lainnya dengan mengatur nilai metadata. Metadata berguna untuk mencari dan memfilter dan menegakkan standar tata kelola. Pusat API menyediakan beberapa properti metadata bawaan umum seperti API type dan lifecycle stage. Pemilik pusat API dapat menambah metadata bawaan dengan menentukan metadata kustom dalam skema metadata untuk mengatur API, penyebaran, dan lingkungan mereka. Misalnya, buat API approver properti metadata untuk mengidentifikasi individu yang bertanggung jawab untuk menyetujui API untuk digunakan.
Azure API Center mendukung metadata kustom array jenis, boolean, angka, objek, pilihan yang telah ditentukan sebelumnya, dan string.
Skema metadata Azure API Center kompatibel dengan spesifikasi skema JSON dan YAML, untuk memungkinkan validasi skema dalam alat pengembang dan alur otomatis.