Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Halaman API memberikan informasi mendetail tentang API. Jika Anda memilih API dari halaman daftar APIs, tab Overview halaman API akan ditampilkan.
Tab Overview memiliki bagian-bagian berikut:
Umum
Panel umum menampilkan informasi tingkat atas tentang API, termasuk hal berikut:
- Nama tampilan: Nama tampilan untuk API. Ditentukan saat mendaftarkan API. Untuk mengedit nama tampilan, lihat Mengedit detail pendaftaran API.
- Deskripsi: Deskripsi API. Ditentukan saat mendaftarkan API. Untuk mengedit deskripsi, lihat Mengedit detail pendaftaran API.
- Elemen taksonomi sistem dan kustom
- Versi dokumen: Link yang membuka revisi spesifikasi yang saat ini ditetapkan untuk deployment. Tombol ini hanya muncul jika API memiliki kumpulan deployment yang direkomendasikan, dan deployment tersebut memiliki versi yang ditetapkan.
- Dapatkan akses: Memberikan petunjuk tentang cara mengakses API ini. Untuk mengubah petunjuk ini, lihat Mengedit deployment. Tombol ini hanya muncul jika ada kumpulan deployment yang direkomendasikan.
Jika label atau tag yang tidak diketahui dilampirkan melalui API publik, label atau tag tersebut tidak akan ditampilkan di UI. Hanya label yang menentukan taksonomi yang diketahui yang ditampilkan.
Nilai taksonomi dapat diberi deskripsi teks atau URL. Di panel ini, jika nilai taksonomi diberi deskripsi teks, ikon info akan ditampilkan di samping nilai yang saat kursor diarahkan ke atasnya, akan menampilkan deskripsi. Jika nilainya adalah URL, nilai taksonomi yang ditampilkan menjadi hyperlink yang akan membuka URL di tab browser baru. Lihat Menambahkan taksonomi untuk informasi selengkapnya.
Mengedit API
Lihat Mengedit detail pendaftaran API.
Menghapus API
Lihat Menghapus API.
Kartu skor
Kartu skor membantu tim memahami cara pengukuran kualitas API. Di seluruh portofolio API, pendekatan penilaian yang cermat dapat membantu mendorong konsistensi di berbagai area, seperti standar desain, profil keamanan, keandalan, atau dimensi lain yang penting bagi bisnis. Hub API dilengkapi dengan lint OpenAPI yang sudah dikonfigurasi.
Kartu skor menunjukkan sekelompok skor yang tidak mudah dikurangi menjadi satu kuantitas.
Skor adalah nilai tunggal yang mewakili beberapa aspek kualitas API. Kualitas dapat ditentukan dalam konteks apa pun (desain, keandalan, kepatuhan, dll.) dan sering kali merupakan masalah pendapat.
Sembunyikan kartu skor
Untuk menyembunyikan UI kartu skor untuk setiap API, lihat Menonaktifkan atau mengaktifkan kartu skor API.
Pilih versi kartu skor
Pilih versi yang akan digunakan untuk kartu skor di menu drop-down Skor spesifikasi ini:
Dengan keterangan:
- Terbaru: Revisi spesifikasi ini memiliki stempel waktu upload terbaru.
- Direkomendasikan: Salah satu revisi spesifikasi ini ditetapkan untuk deployment yang direkomendasikan. Gunakan spesifikasi ini jika Anda adalah konsumen API.
Menyesuaikan kartu skor
Untuk menyesuaikan dan mengonfigurasi kartu skor, gunakan alat command line registry.
Lihat juga: Bagaimana skor dihitung?
Jika Anda ingin menampilkan ikon status di samping error dan peringatan di kartu skor, tentukan nilai minimum:
Dengan keterangan:
| Jenis | Ikon | Deskripsi |
|---|---|---|
| Notifikasi |  |
Tampilkan ikon ini saat nilai minimum berada dalam rentang yang ditentukan untuk pemberitahuan. |
| Peringatan |  |
Tampilkan ikon ini jika nilai minimum berada dalam rentang yang ditentukan untuk peringatan. |
| Oke |  |
Tampilkan ikon ini jika nilai minimum berada dalam rentang yang ditentukan untuk OK. |
Ringkasan lint
Konfigurasi default kartu skor hub API melaporkan peringatan lint dan error lint untuk spesifikasi OpenAPI v2 dan OpenAPI v3 yang telah diupload ke hub API. Hub dan registry API menyertakan linter default berdasarkan Spectral. Linter ini disediakan sebagai contoh referensi untuk kemampuan analisis lint (tanpa mengharapkan dukungan untuk Spectral itu sendiri), menggunakan kumpulan aturan OpenAPI Rules dengan beberapa pengecualian diaktifkan untuk mengurangi derau dari error umum. Memperluas dengan linter kustom saat ini tidak didukung.
Lihat Panduan Gaya API di Registry untuk mendapatkan petunjuk cara mengupdate konfigurasi linter.
Deployment
Tab Deployment menampilkan semua deployment untuk API yang dikonfigurasi oleh API Editor. Deployment merepresentasikan lingkungan langsung tempat API di-deploy. Deployment diurutkan (menurun) berdasarkan nama Environment. Informasi berikut akan ditampilkan:
- Lingkungan
- Dokumentasi
- Indikator deployment yang direkomendasikan
- Gateway
- Panduan penggunaan
- Saluran eksternal
- Dapatkan akses
Untuk informasi lebih lanjut, lihat Mengelola deployment.
Versi
Tab Versions menampilkan semua versi yang telah ditentukan untuk API. Versi diurutkan (menurun) berdasarkan nomor versi. Informasi berikut akan ditampilkan:
- Versi
- Tahap siklus proses
- Revisi terakhir
- Akhir siklus proses (EOL)
Untuk informasi lebih lanjut, lihat Mengelola versi.
Terkait
Panel Related, yang ditampilkan di bagian bawah halaman Overview API, menyediakan link ke informasi lain yang terkait dengan API. Misalnya, kode sumber implementasi, dokumentasi desain, dan sistem infrastruktur. Untuk informasi lebih lanjut, lihat Terkait.
Dependensi
Panel Dependencies yang ditampilkan di bagian bawah halaman Overview API, mencantumkan semua dependensi API, termasuk API internal lainnya (ada di hub API), API pihak ketiga eksternal (tidak ada di hub API), dan sistem produksi lainnya. Misalnya, database dan solusi penyimpanan. Untuk mengetahui informasi lebih lanjut, lihat Dependensi.
