cari
Rumahpembangunan bahagian belakangtutorial phpSepadukan UI Swagger dengan Codeigniter4

Integrate Swagger UI with Codeigniter4

Swagger ialah dokumentasi API yang digunakan secara meluas dan alat ujian yang disepadukan dengan lancar dengan rangka kerja web popular seperti Laravel, Spring Boot, CodeIgniter dan ExpressJS. Dalam artikel ini, kami akan menumpukan pada penyepaduan Swagger dengan CodeIgniter.

Memasang Ketergantungan:

composer require zircote/swagger-php doctrine/annotations

Memuat turun repo SwaggerUI .zip atau SwaggerUI GitHub:

  • Pautan muat turun: keluaran terbaharu SwaggerUI Muat turun keluaran UI Swagger yang paling sesuai dengan keperluan anda.

Menulis Pengawal:

Untuk menjana fail swagger.json untuk UI Swagger, kami perlu mencipta pengawal. Namakan pengawal sebagai pilihan anda, kami berikannya SwaggerDocGenerator.php. Dalam pengawal, kita perlu menggunakan OpenApiGenerator daripada zircote/swagger-php untuk menukar semua sintaks @OA kepada JSON.

<?php namespace App\Controllers;

use OpenApi\Generator;

class SwaggerDocGenerator extends BaseController
{
    /**
     * Generate OpenAPI documentation for the API ...
     * @return string
     */
    public function generate(): string
    {
        // Specify the path where your API controllers are located
        $openapi = Generator::scan([APPPATH . 'Controllers']);

        $swaggerContent = $openapi->toJson();

        // Save the generated OpenAPI content to a file
        $filePath = FCPATH . 'swagger_ui/swagger.json';
        file_put_contents($filePath, $swaggerContent);

        return $swaggerContent;
    }

    /**
     * Render the SwaggerUI ...
     * @return string
     */
    public function index()
    {
        return view('swagger_docs/index');
    }
}

?>

Mencipta Laluan:

Dengan mencipta laluan pada Config/Routes.php, kami akan dapat menjana fail sawgger.json yang dijangkakan.

// Create API documentation ...
$routes->get('api/v1/docs/generate', 'SwaggerDocGenerator::generate');
$routes->get('api/v1/docs/ui', 'SwaggerDocGenerator::index');

Memaparkan UI Swagger:

Terdapat banyak cara untuk menjadikan fail swagger.json anda ke dalam SwaggerUI:

  • Mengimport fail swagger.json ke dalam POSTMAN.
  • Menggunakan SwaggerUI dengan pandangan anda sendiri untuk menghasilkan SwaggerUI.
  • Menyediakan persekitaran ke dalam aplikasi bahagian hadapan anda untuk memaparkan SwaggerUI dengan meminta pada backend-API untuk fail swagger.json.

Dalam ini, kita akan melihat dua cara pertama. Kami akan bercakap tentang cara ke-3 dalam artikel lain.

Mengimport fail swagger.json ke dalam POSTMAN:

  • Salin swagger.json.
  • Buka POSMEN.
  • Klik pada butang Import di penjuru kiri sebelah atas.
  • Tampalkan swagger.json yang disalin.

Menggunakan SwaggerUI dengan pandangan anda sendiri untuk menghasilkan SwaggerUI:

  • Buat fail .php pada apl folder pandangan anda/Views/swagger_docs/index.php untuk memaparkan SwaggerUI.
  • Ekstrak fail SwaggerUI .zip yang dimuat turun ke dalam folder awam/swagger_ui/.
composer require zircote/swagger-php doctrine/annotations

Nota:

  • Pastikan anda menjalankan perintah php spark serve untuk menjalankan aplikasi Codeigniter4.
  • Setiap kali anda membuat perubahan dalam sintaks dokumentasi OpenAPI, anda perlu menjalankan http://localhost:8080/api/v1/docs/generate URL untuk menjana fail swagger.json yang dikemas kini.
  • Pastikan anda mengemas kini fail swagger-initializer.js dengan URL kemas kini fail swagger.json.

Kesimpulan:

Dalam artikel ini, kami meneroka penyepaduan Swagger dengan CodeIgniter 4, menghasilkan fail swagger.json, memaparkannya dalam UI Swagger dan mengimportnya ke dalam Posman. Kami juga menunjukkan cara untuk memaparkan UI Swagger dalam paparan tersuai. Walau bagaimanapun, menjana fail swagger.json secara manual dan mengemas kini URL dalam fail swagger-initializer.js adalah tidak sesuai.

Dalam artikel seterusnya, saya akan menunjukkan mengautomasikan proses ini menggunakan arahan CLI tersuai dan bertujuan untuk membangunkan pakej sumber terbuka untuk tujuan ini. Jangan ragu untuk berkongsi cadangan atau pertanyaan anda di bahagian komen.

Atas ialah kandungan terperinci Sepadukan UI Swagger dengan Codeigniter4. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn
Bagaimanakah PHP mengenal pasti sesi pengguna?Bagaimanakah PHP mengenal pasti sesi pengguna?May 01, 2025 am 12:23 AM

Phpidentifierauser'sSessionusingSessionCookiesandSessionIds.1) whensession_start () ISCALLED, phpGeneratesAuniquesessionIdstoredinacookienamedPhpsessidontheUserer'sBrowser.2) ThisIdallowsPhptoretRievesSessionDataFromtheserver.

Apakah beberapa amalan terbaik untuk mendapatkan sesi PHP?Apakah beberapa amalan terbaik untuk mendapatkan sesi PHP?May 01, 2025 am 12:22 AM

Keselamatan sesi PHP boleh dicapai melalui langkah -langkah berikut: 1. Gunakan session_regenerate_id () untuk menjana semula ID sesi apabila pengguna log masuk atau merupakan operasi penting. 2. Sulitkan ID sesi penghantaran melalui protokol HTTPS. 3. Gunakan session_save_path () untuk menentukan direktori selamat untuk menyimpan data sesi dan menetapkan kebenaran dengan betul.

Di manakah fail sesi php disimpan secara lalai?Di manakah fail sesi php disimpan secara lalai?May 01, 2025 am 12:15 AM

PhpsessionFileSarestoredIntHedirectorySpecifiedBySession.save_path, biasanya/tmponunix-likesystemsorc: \ windows \ temponwindows.tocustomethis: 1) usession_save_path ()

Bagaimana anda mengambil data dari sesi PHP?Bagaimana anda mengambil data dari sesi PHP?May 01, 2025 am 12:11 AM

ToretrievedataFromaphpsession, startTheSessionWithSsion_start () andaccessVariablesInthe $ _SessionArray.Forexample: 1) startTheSession: session_start ()

Bagaimana anda boleh menggunakan sesi untuk melaksanakan keranjang belanja?Bagaimana anda boleh menggunakan sesi untuk melaksanakan keranjang belanja?May 01, 2025 am 12:10 AM

Langkah -langkah untuk membina sistem keranjang belanja yang cekap menggunakan sesi termasuk: 1) Memahami definisi dan fungsi sesi. Sesi ini adalah mekanisme penyimpanan sisi pelayan yang digunakan untuk mengekalkan status pengguna merentasi permintaan; 2) melaksanakan pengurusan sesi asas, seperti menambah produk ke keranjang belanja; 3) memperluas penggunaan lanjutan, menyokong pengurusan kuantiti produk dan penghapusan; 4) Mengoptimumkan prestasi dan keselamatan, dengan berterusan data sesi dan menggunakan pengecam sesi yang selamat.

Bagaimana anda membuat dan menggunakan antara muka dalam PHP?Bagaimana anda membuat dan menggunakan antara muka dalam PHP?Apr 30, 2025 pm 03:40 PM

Artikel ini menerangkan cara membuat, melaksanakan, dan menggunakan antara muka dalam PHP, memberi tumpuan kepada manfaat mereka untuk organisasi kod dan penyelenggaraan.

Apakah perbezaan antara crypt () dan password_hash ()?Apakah perbezaan antara crypt () dan password_hash ()?Apr 30, 2025 pm 03:39 PM

Artikel ini membincangkan perbezaan antara crypt () dan password_hash () dalam php untuk hashing kata laluan, memberi tumpuan kepada pelaksanaan, keselamatan, dan kesesuaian untuk aplikasi web moden.

Bagaimanakah anda dapat mencegah skrip lintas tapak (XSS) dalam PHP?Bagaimanakah anda dapat mencegah skrip lintas tapak (XSS) dalam PHP?Apr 30, 2025 pm 03:38 PM

Artikel membincangkan mencegah skrip lintas tapak (XSS) dalam PHP melalui pengesahan input, pengekodan output, dan menggunakan alat seperti OWASP ESAPI dan pembersih HTML.

See all articles

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

Video Face Swap

Video Face Swap

Tukar muka dalam mana-mana video dengan mudah menggunakan alat tukar muka AI percuma kami!

Alat panas

SublimeText3 versi Cina

SublimeText3 versi Cina

Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1

Hantar Studio 13.0.1

Persekitaran pembangunan bersepadu PHP yang berkuasa

PhpStorm versi Mac

PhpStorm versi Mac

Alat pembangunan bersepadu PHP profesional terkini (2018.2.1).

Dreamweaver CS6

Dreamweaver CS6

Alat pembangunan web visual

SecLists

SecLists

SecLists ialah rakan penguji keselamatan muktamad. Ia ialah koleksi pelbagai jenis senarai yang kerap digunakan semasa penilaian keselamatan, semuanya di satu tempat. SecLists membantu menjadikan ujian keselamatan lebih cekap dan produktif dengan menyediakan semua senarai yang mungkin diperlukan oleh penguji keselamatan dengan mudah. Jenis senarai termasuk nama pengguna, kata laluan, URL, muatan kabur, corak data sensitif, cangkerang web dan banyak lagi. Penguji hanya boleh menarik repositori ini ke mesin ujian baharu dan dia akan mempunyai akses kepada setiap jenis senarai yang dia perlukan.