Pelihat Spesifikasi OpenAPI / Swagger

Render dan terokai dokumentasi titik akhir spesifikasi OpenAPI/Swagger interaktif daripada fail JSON/YAML.

Perihal Pelihat Spesifikasi OpenAPI / Swagger — Panduan Terperinci

Kategori: DevOps & Piawaian 100% Setempat dalam Pelayar

OpenAPI Viewer ialah pembaca dokumentasi sisi klien untuk memeriksa kontrak RESTful API. Alat ini merender spesifikasi Swagger 2.0 dan OpenAPI 3.0 / 3.1 dalam format JSON atau YAML tanpa memerlukan pemasangan Swagger UI setempat mahupun kebergantungan awan.

Ia menampilkan navigasi bar sisi terkumpul yang kemas untuk semua titik akhir, memaparkan laluan, kaedah HTTP (GET, POST, PUT, DELETE), parameter pengepala, rentetan kueri, badan permintaan berstruktur, kod respons HTTP dan skema data.

#openapi #swagger #api #docs #rest #yaml #json

Ciri dan Keupayaan Utama

  • Menyokong spesifikasi Swagger 2.0 dan OpenAPI 3.0 / 3.1 dalam format JSON dan YAML
  • Bar sisi interaktif yang menyenaraikan titik akhir berkategori, kaedah HTTP dan kod status
  • Resolusi skema `$ref` mendalam yang memaparkan model data bersarang dan kekangan sifat
  • Penghuraian luar talian 100% di sisi klien yang memastikan kontrak API proprietari perusahaan kekal selamat

Cara Menggunakan

  1. 1

    Tampal teks `swagger.json` atau `openapi.yaml` anda, atau muat naik fail spesifikasi secara terus.

  2. 2

    Semak imbas dokumentasi API berstruktur yang dirender dalam pemapar interaktif.

  3. 3

    Kembangkan mana-mana titik akhir untuk memeriksa pengepala permintaan, skema muatan permintaan dan sampel respons.

Kes Penggunaan Lazim

  • → Mengaudit definisi API backend tanpa perlu menyediakan pelayan Swagger UI khusus
  • → Melakukan semakan kewarasan pada spesifikasi OpenAPI tulisan tangan untuk mengesan penuding `$ref` yang tidak sah
  • → Menyediakan rujukan skema yang tepat untuk jurutera frontend semasa integrasi API

Alat Berkaitan

Soalan Lazim dan Privasi

Bolehkah alat ini membaca spesifikasi YAML secara terus?

Ya. Penghurai YAML terbina dalam memproses spesifikasi kontrak OpenAPI kedua-dua `.yaml` dan `.json` sepenuhnya dalam penyemak imbas.

Adakah spesifikasi API proprietari saya dimuat naik ke pelayan luaran?

Tidak. Semua penghuraian dokumen dan perenderan skema dilaksanakan sepenuhnya di dalam memori penyemak imbas tempatan anda.