Cara Alat Pengumpulan dan Pelaksanaan API Hobi Berubah Menjadi Produk

Dalam mana-mana permulaan, mengurus API merentas berbilang perkhidmatan ialah cabaran biasa.

Kami menghadapi tiga isu utama:

1. API Mendokumentasikan
2. Menerbitkan dokumentasi
3. Mengemas kininya apabila API berubah

Setiap satu daripada ini mempunyai set soalannya sendiri: bagaimana untuk melakukannya, di mana untuk melakukannya, alat yang akan digunakan dan siapa yang akan mengambil alih.

Untuk menangani perkara ini, pasukan kami memutuskan untuk menyatukan semua API ke dalam satu repositori yang dipanggil APIHub. Setiap API perkhidmatan telah disimpan dalam format yang mudah dan konsisten:

GET | POST | PUT | DELETE | PATCH  
${baseurl}/endpoint  
{  
  "body": "if present"  
}

Kami menamakan fail mengikut fungsinya. Di bawah ialah contoh fail .l2 untuk API "Leave Apply", bersama-sama dengan bar sisi yang menunjukkan API lain dalam repositori:

Memperbaiki Amalan Dokumentasi

Kami mewajibkan untuk memasukkan fail .l2 yang sepadan dalam setiap permintaan tarik/gabung. Jika ia tidak ada, permintaan itu tidak akan diluluskan. Peraturan mudah ini meningkatkan konsistensi dokumentasi API merentas pasukan.

Dari Dokumentasi hingga Pelaksanaan

Kami tidak lama lagi menyedari bahawa menguji API secara manual dengan menyalin URL dan muatan ke alatan seperti Postman memakan masa. Jadi, kami membina alat CLI yang dipanggil Lama2.

Lama2 ialah pengurus API teks biasa yang dioptimumkan untuk kerjasama berasaskan Git.

Dengan Lama2, anda boleh menghantar fail .l2 sebagai input, dan CLI akan melaksanakan API dan menunjukkan respons dalam terminal:

Ini menyelamatkan kami daripada menampal salinan berterusan, tetapi menukar direktori untuk mencari fail .l2 masih membosankan:

lovestaco@i3nux:~/apihub/feedback/fb_v3/leave$ l2 apply_leave.l2  

Membawanya ke VSCode

Untuk menyelaraskan lagi perkara, kami membangunkan sambungan VSCode. Ia datang dengan ciri yang menjadikan aliran kerja kami lebih lancar:

1. Laksanakan fail .l2 terus dalam editor
2. Salin URL Git fail untuk perkongsian mudah
3. Percantik muatan JSON
4. Jana coretan kod untuk sebarang bahasa daripada sintaks .l2
5. Buat templat untuk API baharu dalam beberapa saat
6. Pelengkapan automatik pembolehubah menggunakan LSP

Pelanjutan ini segera menjadi kegemaran di kalangan pasukan, dan kami memutuskan untuk mengeluarkannya di GitHub supaya orang lain juga boleh mendapat manfaat.

Masalah Seterusnya: Penskalaan Dokumentasi

Apabila API kami berkembang, kami bertanya kepada diri sendiri:

• Mengapa mendokumenkan API secara manual untuk setiap perkhidmatan?
• Bukankah ia memakan masa untuk mengemas kini dokumentasi bagi setiap perubahan?

Dan di situlah bermulanya bab seterusnya dalam perjalanan kami...
Ikuti saya untuk mengetahui apa yang berlaku seterusnya dalam siaran saya yang seterusnya.

Atas ialah kandungan terperinci Cara Alat Pengumpulan dan Pelaksanaan API Hobi Berubah Menjadi Produk. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!