, tentu sangat penting untuk berkomunikasi dengan 

mengenai API apa saja yang kita sediakan dan dapat digunakan oleh tim 

 yang diperlukan adalah dokumentasi yang sering disebut sebagai 


Cara paling mudah ya bisa saja dengan dokumen sederhana seperti Word atau Excel. 

karena program-program semacam ini tidak spesifik diperuntukan untuk pembuatan dokumentasi, 

Sulit untuk membuat dokumentasi yang jelas, detil, terstruktur dan terorganisir dengan baik. 

dibuat standarisasi format mengenai bagaimana dokumen ini dibuat, dokumentasi semacam ini akan sulit untuk dikonsumsi.

 seperti Word atau Excel, kita memerlukan 

dan tanpa adanya program ini, dokumentasi tidak dapat digunakan.

Dokumen semacam ini biasanya statis dan tidak 

terjadi pada API, dokumentasi ini akan dengan cepat menjadi 

API kita melalui sebuah UI yang interaktif dan dapat langsung di-

dan sudah cukup banyak integrasinya ke banyak 

salah satunya yang akan kita gunakan, Spring Boot. Konfigurasinya pun sangat mudah, bahkan 

 😂 

Lalu bagaimana bentuk Swagger ini 

API kita? Nah, nantinya, dokumentasi API kita yang dapat dikonsumsi oleh tim 

Bahkan, Swagger memungkinkan kita untuk melakukan 

API tersebut, sehingga penerima dokumentasi dapat langsung melakukan verifikasi dengan cepat (

) apakah API yang kita sediakan dapat mereka pergunakan atau tidak.


Selain itu, Swagger dirancang khusus untuk keperluan dokumentasi API dan sudah sesuai dengan standar 

. Oleh karena itu hasil dokumentasi dari Swagger dapat dengan mudah dan jelas untuk digunakan oleh para 

. Ditambah lagi, Swagger juga sudah menyediakan fitur-fitur seperti 

. Swagger menjamin dokumentasi yang dihasilkan menjadi tetap akurat dan 

Untuk mencoba menggunakan Swagger, kita akan menggunakan project backend API yang saya tulis untuk materi program BCA Advisory Program yaitu 

Advisory Program 2022 (Chapter 1) : Create Your First API

Selanjutnya buat file baru untuk melakukan konfigurasi Swagger. Pada 

Ini adalah konfigurasi minimal yang perlu kita lakukan untuk Swagger. Perlu diperhatikan bahwa kita mendefinisikan 

terhadap komponen-komponen di dalam project kita. Ubah value properti ini sesuai dengan struktur project kalian.

Berikutnya, kita perlu mengaktifkan Swagger dan WebMvc. Aktifasi Swagger dapat kita lakukan melalui anotasi 

. Sedangkan WebMvc diaktifkan dengan anotasi 

. Sebagai informasi, Swagger UI sudah menyediakan UI-nya sendiri, dimana di dalamnya tentu terdapat komponen-komponen 

apabila digunakan untuk membuat aplikasi web yang dapat menghasilkan UI. Salah satu syaratnya, dengan mengaktifkan modul MVC di dalamnya. Inilah alasan mengapa kita memerlukan aktifasi WebMvc.

, kita perlu memberi tahu Spring, bahwa kita menggunakan 

halaman UI Swagger tadi. Tambahkan konfigurasi 

, dengan menggunakan Swagger, kita baru saja membuat dokumentasi API yang jelas, interaktif, mudah digunakan, dan terorganisir hanya dalam 3 langkah! 

bukan? Bayangkan apabila kita perlu membuat dokumen ini menggunakan Word atau Excel 😵‍💫


Untuk mengakses dokumentasi kita, cukup buka browser dan arahkan ke URL aplikasi kita dengan tambahan path 

lah untuk mengetahui apa saja yang sudah di-

untuk kita. Swagger memiliki konfigurasi yang sangat 

dapat lakukan konfigurasi sendiri sesuai 

mengenai integrasi kedua sistem. Bagaimana sebaiknya dokumentasi dibuat?

Easy and Fast API Delivery with Swagger

Swagger is an open source set of rules, specifications and tools for developing and describing RESTful APIs. The Swagger framework allows developers to create interactive, machine and human-readable API documentation.

BLOG TAG

Swagger

Swagger is an open source set of rules, specifications and tools for developing and describing RESTful APIs. The Swagger framework allows developers to create interactive, machine and human-readable API documentation.

Here are some articles tagged with "Swagger" :