Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.Lära Swagger | Restful API
Spring Boot Backend

bookSwagger

I detta kapitel kommer vi att testa applikationen. För detta kommer vi att använda Swagger, ett praktiskt verktyg som inte kräver installation eftersom det är integrerat direkt i vår applikation genom att lägga till det som ett beroende.

Du behöver inte manuellt skriva ut vad varje av dina metoder gör eller vilka möjliga svar den kan returnera; Swagger genererar automatiskt allt detta baserat på din kod och erbjuder ett användarvänligt gränssnitt.

Med Swagger UI kan användare visuellt se hur man interagerar med API:et och testa förfrågningar direkt i webbläsaren, vilket förenklar både utveckling och testning.

Exempel från verkligheten

Föreställ dig en webbutik som tillhandahåller ett API för skapande av beställningar, tillägg av artiklar i kundvagnen, beräkning av fraktkostnader och hantering av betalningar. Utvecklare som arbetar för dina kunder eller partners kan använda detta API för att integrera sina applikationer med ditt system.

Om API:et är väl dokumenterat med hjälp av Swagger, kommer de enkelt att förstå hur de ska anropa nödvändiga metoder, vilka parametrar som ska skickas och vilka svar som kan förväntas — utan att behöva läsa källkoden eller be om förtydliganden.

Integration med Spring Boot

Att integrera Swagger i ett Spring Boot-projekt är enkelt och kräver endast att några beroenden och anoteringar läggs till.

Första steget är att lägga till nödvändiga beroenden i din pom.xml fil (om du använder Maven).

Konfigurera Swagger

Du kan skapa en konfigurationsklass för Swagger om du behöver ange ytterligare parametrar, till exempel:

SwaggerConfig.java

SwaggerConfig.java

copy

              
1234567891011

            
@Configuration
public class SwaggerConfig {

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("spring")
                .pathsToMatch("/**")
                .build();
    }
}

Denna kod konfigurerar Swagger för en Spring Boot-applikation med hjälp av en konfigurationsklass annoterad med @Configuration, vilket indikerar att denna klass kommer att användas för att konfigurera applikationens komponenter. Inuti skapas en bean med hjälp av annoteringen @Bean, vilket gör att Spring kan hantera dess livscykel.

Beanen returnerar ett GroupedOpenApi-objekt, som konfigurerar en API-grupp med namnet spring via metoden group(). Därefter specificerar metoden pathsToMatch("/") att Swagger ska dokumentera alla tillgängliga API-vägar, och anropet till build() slutför konfigurationsprocessen genom att skapa objektet med de angivna parametrarna.

Efter att ha integrerat Swagger i projektet kan du komma åt dokumentationen på:

Sammanfattning

Swagger är ett kraftfullt verktyg för dokumentation av REST API:er, vilket gör API-utveckling, testning och underhåll mycket enklare.

Dess integration med Spring Boot förenklar användningen ytterligare tack vare automatisk generering av dokumentation och det användarvänliga gränssnittet Swagger UI för testning av API:er.

1. Vad är det primära syftet med Swagger?

2. Hur får du åtkomst till Swagger UI efter att ha integrerat det i ett Spring Boot-projekt?

question mark

Vad är det primära syftet med Swagger?

Select the correct answer

question mark

Hur får du åtkomst till Swagger UI efter att ha integrerat det i ett Spring Boot-projekt?

Select the correct answer

Var allt tydligt?

Hur kan vi förbättra det?

Tack för dina kommentarer!

Avsnitt 3. Kapitel 6

Fråga AI

expand

Fråga AI

ChatGPT

Fråga vad du vill eller prova någon av de föreslagna frågorna för att starta vårt samtal

Awesome!

Completion rate improved to 3.45

bookSwagger

Svep för att visa menyn

I detta kapitel kommer vi att testa applikationen. För detta kommer vi att använda Swagger, ett praktiskt verktyg som inte kräver installation eftersom det är integrerat direkt i vår applikation genom att lägga till det som ett beroende.

Du behöver inte manuellt skriva ut vad varje av dina metoder gör eller vilka möjliga svar den kan returnera; Swagger genererar automatiskt allt detta baserat på din kod och erbjuder ett användarvänligt gränssnitt.

Med Swagger UI kan användare visuellt se hur man interagerar med API:et och testa förfrågningar direkt i webbläsaren, vilket förenklar både utveckling och testning.

Exempel från verkligheten

Föreställ dig en webbutik som tillhandahåller ett API för skapande av beställningar, tillägg av artiklar i kundvagnen, beräkning av fraktkostnader och hantering av betalningar. Utvecklare som arbetar för dina kunder eller partners kan använda detta API för att integrera sina applikationer med ditt system.

Om API:et är väl dokumenterat med hjälp av Swagger, kommer de enkelt att förstå hur de ska anropa nödvändiga metoder, vilka parametrar som ska skickas och vilka svar som kan förväntas — utan att behöva läsa källkoden eller be om förtydliganden.

Integration med Spring Boot

Att integrera Swagger i ett Spring Boot-projekt är enkelt och kräver endast att några beroenden och anoteringar läggs till.

Första steget är att lägga till nödvändiga beroenden i din pom.xml fil (om du använder Maven).

Konfigurera Swagger

Du kan skapa en konfigurationsklass för Swagger om du behöver ange ytterligare parametrar, till exempel:

SwaggerConfig.java

SwaggerConfig.java

copy

              
1234567891011

            
@Configuration
public class SwaggerConfig {

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("spring")
                .pathsToMatch("/**")
                .build();
    }
}

Denna kod konfigurerar Swagger för en Spring Boot-applikation med hjälp av en konfigurationsklass annoterad med @Configuration, vilket indikerar att denna klass kommer att användas för att konfigurera applikationens komponenter. Inuti skapas en bean med hjälp av annoteringen @Bean, vilket gör att Spring kan hantera dess livscykel.

Beanen returnerar ett GroupedOpenApi-objekt, som konfigurerar en API-grupp med namnet spring via metoden group(). Därefter specificerar metoden pathsToMatch("/") att Swagger ska dokumentera alla tillgängliga API-vägar, och anropet till build() slutför konfigurationsprocessen genom att skapa objektet med de angivna parametrarna.

Efter att ha integrerat Swagger i projektet kan du komma åt dokumentationen på:

Sammanfattning

Swagger är ett kraftfullt verktyg för dokumentation av REST API:er, vilket gör API-utveckling, testning och underhåll mycket enklare.

Dess integration med Spring Boot förenklar användningen ytterligare tack vare automatisk generering av dokumentation och det användarvänliga gränssnittet Swagger UI för testning av API:er.

1. Vad är det primära syftet med Swagger?

2. Hur får du åtkomst till Swagger UI efter att ha integrerat det i ett Spring Boot-projekt?

question mark

Vad är det primära syftet med Swagger?

Select the correct answer

question mark

Hur får du åtkomst till Swagger UI efter att ha integrerat det i ett Spring Boot-projekt?

Select the correct answer

Var allt tydligt?

Hur kan vi förbättra det?

Tack för dina kommentarer!

Avsnitt 3. Kapitel 6
some-alt