Berhenti menggunakan Swagger-UI dan MSW, gunakan SDK saja

 (dev.to)
14 poin oleh samchon 2023-07-30 | 6 komentar | Bagikan ke WhatsApp

Alat untuk membuat TypeScript SDK dan simulator mockup dari file Swagger.json

SDK (Software Development Kit) di sini mencakup fungsi-fungsi berikut:

  • kumpulan fungsi fetch
  • struktur DTO
  • Simulator Mockup

Dengan membangun dan menggunakan SDK, bagi pengembang front-end (klien) ini jauh lebih mudah dan aman daripada membaca dokumentasi swagger lalu menyalin ulang fungsi fetch dan tipe DTO, serta pekerjaan memocking server back-end dengan msw juga dilakukan secara otomatis, sehingga produktivitas meningkat.

Bacaan terkait

6 komentar

 
roxie 2023-08-05

Tulisan yang bagus, terima kasih atas pendekatannya yang menarik. Mungkin ini hanya preferensi pribadi saya, tetapi saya rasa akan lebih baik jika pada bagian isi di atas ada contoh seperti, "jika kode seperti ini dimasukkan, yang sebelumnya menjadi seperti ini, akan berubah menjadi seperti itu." Dalam bentuknya yang sekarang, isi artikelnya hampir tidak menarik perhatian saya sama sekali.
 
kuber 2023-07-30

Di ekosistem TS, apakah hal yang umum untuk melihat dokumentasi lalu mendefinisikan tipe dan fungsi terkait secara manual?
 
hyeonss0417 2023-07-31

Terkait hal ini, ada library bernama Tspec yang bisa secara otomatis menghasilkan OpenAPI Spec berdasarkan tipe TypeScript hehe

https://github.com/ts-spec/tspec
 
samchon 2023-07-31

Untuk TS, kode yang dihasilkan openapi-generator kurang layak dipakai.
 
kunggom 2023-07-30

Sepertinya ini adalah cara penggunaan alat yang dibuat langsung oleh samchon, yang mengunggah tulisan ini, jadi saya juga merasa mungkin seharusnya masuk ke bagian Show GN.

Bagaimanapun, membuat autocomplete di klien TypeScript menggunakan file swagger.json terdengar seperti ide yang bagus. Apakah ini juga bisa digunakan di stack backend lain selain NestJS?
 
samchon 2023-07-30

Terlepas dari bahasa atau framework, yang diperlukan hanya bisa membangun swagger.json dengan spesifikasi OpenAPI v3.0.

Sebelumnya saya juga pernah mengunggah tulisan blog dengan label show GN, tetapi saat itu admin mengatakan bahwa show GN adalah tempat untuk mengunggah hanya tautan GitHub atau proyek, lalu memindahkannya menjadi tulisan umum.