10 Template Gratis untuk Dokumentasi API


Apakah Anda perlu membuat dokumentasi API untuk API Anda yang tenang? Ingin membuat dokumentasi API secara otomatis? Hari ini, saya akan membagikan beberapa template gratis yang dirancang untuk menampilkan API Anda. Dokumentasi yang baik sangat penting jadi mulailah dengan dasar yang baik. Sumber daya API ini sederhana, bersih, leverage praktik terbaik, dan akan membuat pengguna API Anda senang.
1. Slate - membantu Anda membuat dokumentasi API yang indah. Ini responsif, menggunakan penurunan harga dan Ruby, dan ini terinspirasi oleh dokumentasi API Stripe dan Paypal . Berikut adalah demo .
2. dokumentasi APIDoc - inline untuk API Web yang tenang yang dibuat dari anotasi API di kode sumber Anda.Temanya adalah 2 kolom dan ini adalah demo .
3. FlatDoc - membuat dokumentasi penulisan menjadi mudah. Tidak ada proses yang dibangun, hanya file JavaScript kecil yang mengambil file penurunan harga dan menjadikannya sebagai halaman penuh. Anda membuat dokumentasi dari file Readme. Tema defaultnya responsif dan Anda dapat menyebarkannya melalui Github Pages.
4. Spesifikasi API Webservice Doc Template - template doc API mudah, sederhana, bersih yang dibuat sebagai halaman Google Doc.
5. API Blueprint - memberi Anda alat mengagumkan untuk keseluruhan siklus hidup API Anda. Anda bisa membuat dokumentasi secara otomatis dan lebih banyak lagi dengan tool ini.Berikut adalah beberapa contohnya .Juga, periksa aglio , renderer cetak biru API.
6. Swagger - antarmuka yang sederhana dan kuat untuk API Anda.Banyak otomasi, perkakas API, dan bahkan pembuatan SDK klien dan kemampuan untuk dapat ditemukan.Lihat demo live .
7. Calamum - menghasilkan dokumentasi REST API dari file JSON.Ini memiliki template twitter dan template bootstrap.
8. miredot adalah generator dokumentasi REST API untuk Java.Simak contohnya .
9. RAML - cara sederhana dan ringkas untuk mendeskripsikan API yang tenang. Ini dibangun berdasarkan standar yang digunakan secara luas seperti YAML dan JSON dan memiliki banyak alat, salah satunya adalah RAML to HTML yang menampilkan dokumentasi berdasarkan file RAML.
10. RestDoc - script PHP untuk menghasilkan dokumentasi REST dari file YAML.

Luar

Post a Comment

0 Comments