Cara Menggunakan OpenAPI dan Swagger di VSCode

 

Dalam proses pengembangan web, kita terkadang ingin membuat beberapa API untuk terhubung ke dalam beberapa aplikasi lainnya. Swagger membantu kita melakukan hal tersebut, kita bisa membuat detak, route api kita, method yang ingin digunakan, dan deskripsinya. Ini sangat membantu untuk pengembangan web kedepannya

Postingan ini akan membahas:

  • Apa Itu Swagger?
  • Cara Menggunakan Swagger di Vscode

 

Apa Itu Swagger

Swagger adalah sebuah tools untuk membuat dokumentasi dari API yang kita buat. Swagger sangat penting supaya para developer yang bekerja sama dengan kita bisa memahami aplikasi kita dengan baik dan benar

Baca Juga: Cara Membuat Aplikasi Web Dari Nol 

Cara Menggunakannya

Kalian bisa mendownload extensinya di Vscode dengan judul Swagger Viewer

Jika sudah. buat folder tersendiri di project kalian, kalian bisa menamainya ./docs dan buat file user-api.json

Buat detail api seperti ini

{
    "openapi": "3.0.3",
    "info": {
        "title": "User API",
        "description": "User API",
        "version": "1.0.0"
    },
    "servers": [
        {
            "url": "http://localhost:8000"
        }
    ],
    "paths": {
        "/api/users": {
            "post": {
                "description": "Register new user"
            }
        },
        "/api/users/login": {
            "post": {
                "description": "Login User"
            }
        },
        "/api/users/current": {
            "get": {
                "description": "get current user"
            },
            "patch": {
                "description": "update current user"
            }
        },
        "/api/users/logout": {
            "description": "logout current user"
        }
    }
}


 Jika sudah tekan Ctrl + P lalu >, dan pilih Swagger Preview


Semoga postingan ini bisa membantu!

Comments

Post a Comment

Popular posts from this blog

Cara Mengatasi Hang/Freeze Pada Laptop Asus TUF Gaming

Image
  Ada beberapa kendala ketika membeli laptop. Seperti ada aplikasi yang tidak kompaktibel, ada yang hardwarenya crashed, dan bahkan memang harus dibawa ke manufakturnya untuk diktukar karena ada barang yang kita beli adalah miss saat quality control Terlepas dari semua kendala tersebut. Saya akan memberikan sekedar solusi yang bisa menjadi manfaat jika permasalahan itu sama dengan kalian. Yaitu, laptop yang suka freeze, hang, saat kita operasikan Sedikit Cerita Saya belum ada setahun menggunakan laptop Asus varian Tuf Gaming ini. Namun saat beberapa minggu pertama saya mencobanya, ada beberapa kendala yaitu laptop sering hang dan freeze tanpa sebab. Ini terjadi secara tiba tiba. Dan seumpamam saya bawa lagi ke outlet laptop ini berasal, saya gak bisa memberikan alasan yang jelas kenapa laptop ini bisa freeze dan hang. Karena memang terjadi tiba tiba saja.    Baca Juga: Cara Menjadi Web Developer Di Tahun 2024   Hingga beberapa bulan selanjutnya, laptop ini semakin se...
Read more

Cara Menjalankan PHP 8 & Laravel 9 Pada Laragon

Image
  Ketika kalian menggunakan aplikasi Laragon, biasanya saat Php muncul versi terbaru, atau apache atau mysql juga muncul versi terbaru, Laragon tidak mau mengupdate secara otomatis. Alih alih kita harus menambahkan sendiri versi PHP yang diinginkan dengan mendownloadnya dari situs resminya Kali ini semua masalah tersebut tidak akan menjadi halangan, karena saya sudah pernah mencoba sendiri dan mengatur sendiri Laragon agar bisa menjalankan PHP 8 (versi PHP terbaru), MySQl dan Apache dengan versi terbaru Biasanya hal ini dibutuhkan ketika kita ingin menjalankan Laravel 9 yang hanya support untuk PHP 8 Bagaimana caranya? Kita ikuti langkah langkah dibawah Peralatan php-8.1.13-nts-Win32-vs16-x64 mysql-8.0.x.-winx64 phpMyAdmin-5.2.0-all-languages Langkah Langkah Download PHP 8 lewat link ini Setelah itu ekstrak di folder ini C:\laragon\bin\php Lalu buka Laragon kalian dan jalankan Setelah itu klik kanan. Lalu pilih PHP, Version dan pilih php-8.xxxxxx Lebih lengkapnya bisa lihat gambar ...
Read more

Tutorial NextJS 13 & Typescript: Membuat Navbar Dengan Shadcn/UI

Image
  Ada dua stack teknologi yang saya perhatikan sedang ramai diperbincangkan di sosial media. Pertama, NextJS dan kedua Typescript. Sebenarnya apa sih yang bikin kedua teknologi ini trending?     Saya mendefisinisikan Typescript adalah javascript dengan gaya. Artinya Typescript adalah javascript yang memiliki fitur lanjutan dimana kita sebagai programmer bisa mengoptimasi penggunaan tipe data menjadi lebih detail sehingga kode minim error     "Ahh, saya ngoding pake Typescript justru muncul banyak error"     Eitssss, jangan salah. Disitulah peran Typescript dimana ia mengingatkan programmer bahwa ada beberapa sisi dalam codingan kita yang bisa diimprove lagi     Kali ini kita akan menjajal menggunakan NextJS dan Typescript untuk membuat Navbar sederhana. Dengan adanya tutorial ini, saya berharap kita semakin faham alur ngoding menggunakan NextJS dan barang kali lebih luwes ketika ingin membuat komponen ReactJS yang lain Baca Juga: Mari Bongka...
Read more