api html
1.0.0
Ubah Spesifikasi API apa pun menjadi situs web dokumentasi HTML yang mengagumkan
HTML API
npm i api-html -g
api-html --url https://petstore.swagger.io/v2/swagger.json
Demo
Perintah di atas akan mengubah url yang diberikan menjadi situs web statis di direktori saat ini dengan nama direktori dist .
Ada juga kemungkinan untuk meneruskan file alih-alih url .
| Param | Pendek | Diperlukan | Nilai Bawaan | Detail |
|---|---|---|---|---|
--file | -f | required | batal | Jalur ke file sumber lokal, --file atau --url on diperlukan secara bersamaan. |
--url | -u | required | batal | URL ke file sumber online, --file atau --url aktif diperlukan secara bersamaan. |
--type | -t | opsional | swagger | Jenis spesifikasi API yang dikodekan, seperti swagger , openapi , api_blueprint , io_docs , google , raml atau wadl |
--version | -v | opsional | 2 | Versi OpenAPI ( swagger ), nilai yang mungkin adalah 1, 2 atau 3. Hanya berlaku untuk swagger |
--yaml | -y | opsional | 0 | Jika jenis file sumbernya adalah yaml maka nilainya harus 1 , hanya berlaku untuk swagger |
--option | -o | opsional | ./options.json | Path ke file opsi, lihat detailnya di bawah ini |
api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml
# A Swagger (OpenAPI) version 2 source file with yaml type
api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json
# A Swagger (OpenAPI) version 3 source file with json type
api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
# A Swagger (OpenAPI) version 3 source file with yaml type
api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md
# An API Blueprint source file
api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest
# A Google API descory source file
api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml
# A RAML source file
api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json
# An IO Docs source file
Opsinya harus ada dalam file json, Jika Anda tidak meneruskan parameter --option maka kami akan memeriksa di direktori saat ini dengan nama options.json .
| Nama | Nilai Bawaan | Keterangan |
|---|---|---|
theme | compact | Tetapkan tema UI, nilainya adalah: "kompak" dan "dasar". |
baseColor | #6e9a04 | Tetapkan warna dasar tema |
textColor | #FFF | Atur warna teks tema |
logo | 'logo angkuh' | Arahkan logo ke file lokal |
logoUrl | '' | Arahkan logo ke URL |
isCoding | true | Tampilkan atau Sembunyikan bagian pengkodean dalam permintaan |
isSearch | true | Tampilkan atau Sembunyikan fitur Pencarian |
isTryRequest | true | Tampilkan atau Sembunyikan tombol "coba" dalam permintaan |
isBackToTopButton | true | Sembunyikan atau tampilkan tombol BackToTop |
isCreditLink | true | Sembunyikan atau tampilkan tautan Credit di bawah bilah navigasi |
pageTitle | title dari file swagger.json | Atur judul halaman yang ditampilkan pada bilah judul browser. |
customHeadScript | '' | Tambahkan skrip khusus ke tag head |
customFootScript | '' | Tambahkan skrip khusus ke tag kaki |
pageTags | '' | Mewakili kata kunci meta halaman, Setiap kata kunci harus dipisahkan dengan koma. Meta Kata Kunci berguna untuk SEO halaman. |
pageDescription | '' | Mewakili deskripsi meta halaman |
apiVersions | '' | Versi API, masukkan dalam format berikut: (Nama)[URL] (Nama)[URL] ... Kedaluwarsa: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/] |
headerMenuItems | '' | Item Menu Header, masukkan dalam format berikut: (Nama)[URL] (Nama)[URL] ... Kedaluwarsa: (Situs Web Utama)[https://zamacall.io] (Hubungi Kami)[https://zamacall.io/contact/] |
{
"logo": "logo.svg",
"baseColor": "blue"
}
IO DocsWADLRAMLGoogle API DescoryAPI BlueprintYAMLOpenAPI (swagger) versi 1, 2, & 3.cURL , Node , Python & JavaScriptMasalah Github
