Azure API Center - konsep utama
Artikel ini menjelaskan konsep utama Azure API Center. Azure API Center memungkinkan PELACAKAN API di lokasi terpusat untuk penemuan, penggunaan kembali, dan tata kelola.
Model data
Diagram berikut menunjukkan entitas utama di Azure API Center dan bagaimana mereka berhubungan satu sama lain. Lihat bagian berikut untuk informasi selengkapnya tentang entitas ini dan konsep terkait.
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.
API dalam inventori dapat dikelola oleh solusi manajemen API apa pun, seperti 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.
Inventori API di Azure API Center dirancang untuk dibuat dan dikelola oleh manajer program API atau administrator TI.
versi API
Penerapan versi API adalah praktik mengelola perubahan pada API dan memastikan bahwa perubahan ini 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 melanggar, sementara yang lain menambahkan peningkatan kecil. Versi API dapat berada pada tahap siklus hidup apa pun - dari desain, hingga pratinjau, produksi, atau tidak digunakan lagi.
Definisi API
Setiap versi API idealnya harus didefinisikan oleh setidaknya satu definisi, 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.
Lingkungan
Lingkungan mewakili lokasi tempat runtime API dapat disebarkan, misalnya, layanan Azure API Management, layanan Apigee API Management, atau layanan komputasi seperti kluster Kubernetes, Aplikasi Web, atau Azure Function. Setiap lingkungan selaras dengan tahap siklus hidup seperti pengembangan, pengujian, penahapan, atau produksi. Lingkungan juga dapat mencakup informasi tentang portal pengembang atau antarmuka manajemen.
Catatan
Gunakan Azure API Center untuk melacak salah satu lingkungan runtime API Anda, baik yang dihosting di infrastruktur Azure atau tidak. 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, yang dapat digunakan untuk pencarian dan pemfilteran dan untuk menegakkan standar tata kelola. Pusat API menyediakan beberapa properti metadata bawaan umum seperti "jenis API" dan "tahap siklus hidup". Pemilik pusat API dapat menambah metadata bawaan dengan menentukan metadata kustom dalam skema metadata untuk mengatur API, penyebaran, dan lingkungan mereka. Misalnya, buat properti pemberi izin API 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.