Swagger untuk dokumentasi API

Swagger adalah kerangka perangkat lunak sumber terbuka yang membantu pengembang merancang, membangun, mendokumentasikan, dan menggunakan RESTful API. Dokumentasi Swagger adalah representasi dari RESTful API yang dibuat menggunakan spesifikasi Swagger. Spesifikasi Swagger adalah bahasa deskripsi antarmuka standar untuk REST API. Ini memungkinkan pengembang untuk mendeskripsikan struktur API mereka dan menghasilkan dokumentasi dalam format yang dapat dibaca manusia. Dokumentasi Swagger yang dihasilkan mencakup informasi tentang titik akhir API, parameter permintaan dan respons, serta detail relevan lainnya. Itu dapat digunakan oleh pengembang lain untuk memahami fungsionalitas API dan melakukan panggilan ke sana.

Fitur menyombongkan diri

Dokumentasi Swagger menyediakan sejumlah fitur, termasuk:

1. Dokumentasi interaktif: Memungkinkan pengembang untuk mencoba panggilan API dan melihat responsnya di UI berbasis browser.
2. Definisi API: Memberikan definisi yang jelas, ringkas, dan ramah manusia tentang apa yang dilakukan API, titik akhir, parameter, dan respons yang diharapkan.
3. Pembuatan Kode: Menghasilkan kode server dan klien dalam berbagai bahasa pemrograman untuk membantu mempercepat proses pengembangan.
4. Validasi: Secara otomatis memvalidasi permintaan dan tanggapan API untuk memastikan mereka memenuhi spesifikasi API.
5. Pembuatan Dokumentasi: Secara otomatis menghasilkan dokumentasi API dalam berbagai format, termasuk HTML, JSON, dan YAML.
6. Kolaborasi: Mendukung kolaborasi antara pembuat API, pengembang, dan pemangku kepentingan, dengan menyediakan lokasi terpusat untuk dokumentasi API.
7. Pengujian: Menyediakan lingkungan untuk menguji panggilan API dan memastikan bahwa mereka memenuhi perilaku yang diinginkan.
8. Pembuatan Versi: Mendukung pembuatan versi API dan memungkinkan pengguna untuk melihat dan bekerja dengan beberapa versi API.

Dokumentasi Swagger mendukung beberapa bahasa pemrograman termasuk:

1. Jawa
2. Node.js
3. PHP
4. Piton
5. Rubi
6. Pergi
7. C#
8. Skala
9. Perl

Aktifkan Swagger di boot Spring

Untuk mengaktifkan dokumentasi Swagger di aplikasi boot musim semi, Anda harus mengikuti langkah-langkah berikut:

1. Tambahkan dependensi springfox-swagger2 dan springfox-swagger-ui ke proyek.
2. Aktifkan dukungan Swagger di aplikasi Spring Boot Anda dengan menganotasi kelas konfigurasi Anda dengan @EnableSwagger2.
3. Buat kacang Docket untuk mengonfigurasi properti Swagger, seperti versi API, judul, dan deskripsi.
4. Beri anotasi pada RESTful API Anda dengan anotasi Swagger yang sesuai, seperti @Api, @ApiOperation, @ApiParam, dll.
5. Jalankan aplikasi Spring Boot dan akses UI Swagger di URLhttp://localhost:port/swagger-ui.html, di mana port adalah port HTTP tempat aplikasi Anda berjalan.

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

Menyiapkan Swagger 2 dengan Spring REST API | Baeldung

Mendokumentasikan Spring REST API Menggunakan OpenAPI 3.0 | Baeldung