API belgeleri için Swagger

Swagger, geliştiricilerin RESTful API'leri tasarlamasına, oluşturmasına, belgelemesine ve kullanmasına yardımcı olan açık kaynaklı bir yazılım çerçevesidir. Swagger belgeleri, Swagger belirtimi kullanılarak oluşturulan bir RESTful API'nin temsilidir. Swagger belirtimi, REST API'leri için standart bir arabirim tanımlama dilidir. Geliştiricilerin API'lerinin yapısını tanımlamasına ve insanlar tarafından okunabilir bir biçimde belgeler oluşturmasına olanak tanır. Oluşturulan Swagger belgeleri, API uç noktaları, istek ve yanıt parametreleri ve diğer ilgili ayrıntılar hakkında bilgiler içerir. API'nin işlevselliğini anlamak ve ona çağrı yapmak için diğer geliştiriciler tarafından kullanılabilir.

Havalı özellikler

Swagger belgeleri, aşağıdakiler de dahil olmak üzere bir dizi özellik sağlar:

1. Etkileşimli belgeler: Geliştiricilerin API çağrılarını denemelerine ve yanıtları tarayıcı tabanlı bir kullanıcı arabiriminde görmelerine olanak tanır.
2. API Tanımı: API'nin ne yaptığı, uç noktaları, parametreleri ve beklenen yanıtları hakkında net, özlü ve insan dostu bir tanım sağlar.
3. Kod Oluşturma: Geliştirme sürecini hızlandırmaya yardımcı olmak için birden çok programlama dilinde sunucu ve istemci kodu üretir.
4. Doğrulama: API spesifikasyonunu karşıladıklarından emin olmak için API isteklerini ve yanıtlarını otomatik olarak doğrular.
5. Belge Oluşturma: API belgelerini HTML, JSON ve YAML dahil olmak üzere çeşitli biçimlerde otomatik olarak oluşturur.
6. İşbirliği: API belgeleri için merkezi bir konum sağlayarak API oluşturucuları, geliştiricileri ve paydaşları arasındaki işbirliğini destekler.
7. Test Etme: API çağrılarını test etmek ve istenen davranışı karşıladıklarından emin olmak için bir ortam sağlar.
8. Sürüm Oluşturma: API'lerin sürüm oluşturmasını destekler ve kullanıcıların bir API'nin birden çok sürümünü görüntülemesine ve bunlarla çalışmasına olanak tanır.

Swagger belgeleri, aşağıdakiler dahil olmak üzere çeşitli programlama dillerini destekler:

1. java
2. Node.js
3. PHP
4. Piton
5. Yakut
6. Gitmek
7. C#
8. Scala
9. perl

İlkbahar önyüklemesinde Swagger'ı etkinleştirin

Yaylı önyükleme uygulamasında Swagger belgelerini etkinleştirmek için şu adımları izlemeniz gerekir:

1. Springfox-swagger2 ve springfox-swagger-ui bağımlılıklarını projeye ekleyin.
2. Yapılandırma sınıfınıza @EnableSwagger2 ile açıklama ekleyerek Spring Boot uygulamanızda Swagger desteğini etkinleştirin.
3. API sürümü, başlık ve açıklama gibi Swagger özelliklerini yapılandırmak için bir Docket bean oluşturun.
4. RESTful API'lerinize @Api, @ApiOperation, @ApiParam vb. gibi uygun Swagger ek açıklamalarıyla açıklama ekleyin.
5. Spring Boot uygulamasını çalıştırın ve URL'den Swagger kullanıcı arayüzüne erişinhttp://localhost:port/swagger-ui.html, burada bağlantı noktası, uygulamanızın üzerinde çalıştığı HTTP bağlantı noktasıdır.

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

Swagger 2'yi Spring REST API ile Kurma | baeldung

OpenAPI 3.0 Kullanarak Spring REST API'sini Belgeleme | baeldung