insomnia documenter

Seperti Postman Documenter tetapi untuk Insomnia! Dengan alat ini Anda dapat membuat halaman dokumentasi API yang indah menggunakan file ekspor Insomnia Anda.

Demo: https://insodoc.github.io/insomnia-documenter/
Video tutorial dan demo: https://www.youtube.com/watch?v=pq2u3FqVVy8

Daftar isi

• Daftar isi
• Persyaratan
• Memulai
  • Menggunakan npx
  • Dengan menginstal paket secara global
  • Pilihan
  • Menggunakan rilis GitHub
• Memperbarui API
• Jalur Root Kustom
• Menjalankan Halaman Secara Lokal
• Plugin Insomnia
• log perubahan
• Kontribusi
• Lisensi
• Dokumenter Insomnia untuk perusahaan

Persyaratan

• Node.js (disarankan 8.x atau lebih tinggi)
• JSON ruang kerja Insomnia yang diekspor (v4)

Memulai

Insomnia Documenter menawarkan alat CLI untuk mempermudah pengaturan halaman dokumentasi. Anda dapat menggunakannya dengan dua cara.

Menggunakan npx

npx insomnia-documenter --config /path/to/insomnia/config.json

Dengan menginstal paket secara global

npm i -g insomnia-documenter
insomnia-documenter --config /path/to/insomnia/config.json

Pilihan

 Options:
  -c, --config <location>  Location of the exported Insomnia JSON config.
  -l, --logo <location>    Project logo location (48x48px PNG).
  -f, --favicon <location>    Project favicon location (ICO).
  -o, --output <location>  Where to save the file (defaults to current working directory).
  -h, --help               output usage information

Menggunakan rilis GitHub

Alternatifnya, Anda dapat mulai menggunakan Insomnia Documenter dengan mengunduh arsip rilis dari GitHub dan menambahkan file ekspor insomnia.json ke direktori root situs Anda.

Memperbarui API

Memperbarui API sangatlah mudah! Karena Insomnia Documenter adalah aplikasi web plug-and-play, Anda cukup mengganti insomnia.json Anda dengan file JSON baru yang diekspor. Pastikan saja itu disebut insomnia.json .

Hal yang sama juga berlaku pada logo ( logo.png ) dan favicon ( favicon.ico ).

Jalur Root Kustom

Mungkin Anda ingin mendokumentasikan beberapa API di domain yang sama? Mungkin Anda ingin menghosting halaman dokumentasi Anda di halaman GitHub? Dalam hal ini (banyak kasus lainnya), Anda perlu menentukan jalur root. Untuk melakukan ini, Anda harus membuka index.html dan mengganti baris berikut:

 < div id =" app " > </ div >

dengan sesuatu seperti ini:

 < div id =" app " data-root =" /path/to/docs " > </ div >

Dalam hal ini, aplikasi akan mengambil file insomnia.json dari direktori /path/to/docs . Hal ini memberi Anda lebih banyak fleksibilitas mengenai bagaimana Anda ingin mempertahankan halaman dokumentasi Anda (misalnya, Anda dapat menyimpan file ekspor di tempat lain selain direktori akar halaman web). Anda TIDAK boleh memberi tanda garis miring pada properti data-root .

Harap dicatat bahwa pengaturan atribut ini tidak akan mempengaruhi favicon dan logo halaman. Mereka masih akan dimuat dari direktori yang sama di mana index.html berada.

Menjalankan Halaman Secara Lokal

Membuka file index.html akan gagal dimuat dalam 99,9% kasus karena itulah cara kerja pengambilan. Untuk melihat pratinjau halaman secara lokal, Anda mungkin ingin menggunakan alat seperti zeit/serve:

npx serve

Halaman ini akan tersedia di http://localhost:5000.

Plugin Insomnia

devhammed telah membuat Plugin Insomnia mengagumkan yang memungkinkan Anda membuat halaman dokumentasi langsung dari antarmuka Insomnia. Dapatkan Pluginnya (npm - github)

log perubahan

Silakan lihat dokumen Changelog.

Kontribusi

Alat CLI adalah applet komandan, sedangkan frontendnya sendiri adalah aplikasi Svelte. Proyek ini masih dalam tahap beta yang artinya masih terdapat bug dan masih dapat diperbaiki disana-sini. Kontribusi sangat diharapkan :)

Kloning repositori:

git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenter

Instal dependensi:

npm install

Salin file ekspor demo Insomnia:

cp docs/insomnia.json public/insomnia.json

Jalankan pembangunan pengembangan dengan hot reload:

npm run dev

Buat build produksi:

npm run build

Linting:

npm run lint

Pengujian:

npm run test 

Lisensi

MIT.

Catatan: proyek ini tidak berafiliasi dengan Kong dan/atau Insomnia.

Dokumenter Insomnia untuk perusahaan

Tersedia sebagai bagian dari Langganan Tidelift

Pengelola Insomnia Documenter dan ribuan paket lainnya bekerja sama dengan Tidelift untuk memberikan dukungan komersial dan pemeliharaan untuk dependensi sumber terbuka yang Anda gunakan untuk membangun aplikasi Anda. Menghemat waktu, mengurangi risiko, dan meningkatkan kesehatan kode, sekaligus membayar pengelola dependensi yang Anda gunakan. Pelajari lebih lanjut.