Swagger do dokumentacji API

Swagger to platforma oprogramowania typu open source, która pomaga programistom projektować, budować, dokumentować i wykorzystywać interfejsy API RESTful. Dokumentacja Swaggera jest reprezentacją RESTful API utworzonego przy użyciu specyfikacji Swaggera. Specyfikacja Swagger to standardowy język opisu interfejsu dla interfejsów API REST. Pozwala programistom opisywać strukturę ich interfejsów API i generować dokumentację w formacie czytelnym dla człowieka. Wygenerowana dokumentacja Swaggera zawiera informacje o punktach końcowych interfejsu API, parametrach żądania i odpowiedzi oraz inne istotne szczegóły. Może być używany przez innych programistów do zrozumienia funkcjonalności interfejsu API i wykonywania z nim wywołań.

Funkcje Swaggera

Dokumentacja Swagger zapewnia szereg funkcji, w tym:

1. Dokumentacja interaktywna: umożliwia programistom wypróbowanie wywołań interfejsu API i zobaczenie odpowiedzi w interfejsie użytkownika opartym na przeglądarce.
2. Definicja interfejsu API: zawiera jasną, zwięzłą i przyjazną dla człowieka definicję działania interfejsu API, jego punktów końcowych, parametrów i oczekiwanych odpowiedzi.
3. Generowanie kodu: Generuje kod serwera i klienta w wielu językach programowania, aby przyspieszyć proces programowania.
4. Walidacja: Automatycznie weryfikuje żądania i odpowiedzi interfejsu API, aby upewnić się, że spełniają one specyfikację interfejsu API.
5. Generowanie dokumentacji: automatycznie generuje dokumentację API w różnych formatach, w tym HTML, JSON i YAML.
6. Współpraca: obsługuje współpracę między twórcami interfejsów API, programistami i interesariuszami, udostępniając scentralizowaną lokalizację dokumentacji interfejsu API.
7. Testowanie: zapewnia środowisko do testowania wywołań interfejsu API i sprawdzania, czy spełniają one pożądane zachowanie.
8. Wersjonowanie: obsługuje wersjonowanie interfejsów API i umożliwia użytkownikom przeglądanie i pracę z wieloma wersjami interfejsu API.

Dokumentacja Swagger obsługuje kilka języków programowania, w tym:

1. Jawa
2. Node.js
3. PHP
4. Pyton
5. Rubin
6. Iść
7. C#
8. Scala
9. Perl

Włącz Swagger w wiosennym rozruchu

Aby włączyć dokumentację Swaggera w aplikacji wiosennego rozruchu, musisz wykonać następujące kroki:

1. Dodaj zależności springfox-swagger2 i springfox-swagger-ui do projektu.
2. Włącz obsługę Swagger w swojej aplikacji Spring Boot, dodając adnotację do swojej klasy konfiguracji za pomocą @EnableSwagger2.
3. Utwórz komponent bean Docket, aby skonfigurować właściwości Swaggera, takie jak wersja interfejsu API, tytuł i opis.
4. Dodaj adnotacje do interfejsów API RESTful za pomocą odpowiednich adnotacji Swagger, takich jak @Api, @ApiOperation, @ApiParam itp.
5. Uruchom aplikację Spring Boot i uzyskaj dostęp do interfejsu Swagger pod adresem URLhttp://localhost:port/swagger-ui.html, gdzie port to port HTTP, na którym działa aplikacja.

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

Konfigurowanie Swaggera 2 za pomocą Spring REST API | Baeldung

Dokumentowanie Spring REST API przy użyciu OpenAPI 3.0 | Baeldung