Spring Boot 4-mikrotjenester og REST-API'er · Lektion

Swagger UI

Udforsk og test API'er interaktivt.

Lektion 4 af 413 trin

Swagger UI er en gratis Spring Boot 4-mikrotjenester og REST-API'er-lektion på CoddyKit. Dette er lektion 4 af 4. Du kan læse hele lektionen gratis nedenfor — og derefter øve dig praktisk i browseren med en indbygget kodeeditor og en AI-vejleder, der er tilgængelig døgnet rundt. Den er en del af læringsforløbet i Spring Boot 4-mikrotjenester og REST-API'er, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. Spring Boot 4-mikrotjenester og REST-API'er-kurset indeholder 4 lektioner i alt.

Hvad er Swagger UI?

Swagger UI gengiver din OpenAPI-specifikation som en interaktiv webside. Udviklere kan gennemse endpoints, læse skemaer og sende virkelige forespørgsler – alt sammen fra browseren.

Hvor den findes

Med -ui-starteren leveres Swagger UI som standard på /swagger-ui.html. Den indlæser specifikationen fra /v3/api-docs.

// open in a browser:
// http://localhost:8080/swagger-ui.html

Prøv det

Hver handling har en knap med teksten Prøv det. Du udfylder parametre og legeme, klikker på Udfør, og brugerfladen viser den faktiske forespørgsels-URL, svarstatus, headere og legeme.

Læsning af skemavisningen

Sektionen Skemaer nederst viser alle modeller med felttyper, beskrivelser og eksempler fra dine @Schema-annotations.

Ændring af brugerfladens sti

Flyt brugerfladen med en egenskab – nyttigt, når dokumentationen skal leveres under en brugerdefineret rute.

# application.yml
springdoc:
  swagger-ui:
    path: /docs

Sortering af endpoints og tags

Som standard vises handlingerne i en usorteret rækkefølge. Med egenskaber kan du sortere handlinger og tags alfabetisk, så siden bliver mere overskuelig.

springdoc:
  swagger-ui:
    operations-sorter: alpha
    tags-sorter: alpha

Afprøvning af sikrede endpoints

Hvis du har deklareret et sikkerhedsskema, viser brugerfladen en knap med teksten Godkend. Angiv et token én gang, så føjes det til hver sikret forespørgsel, du afprøver.

Filtrering af handlinger

Aktivér et søgefelt for at filtrere den lange liste over endpoints efter navn. Det er nyttigt i store API'er.

springdoc:
  swagger-ui:
    filter: true

Visningsindstillinger

Du kan styre, hvor meget der som standard udfoldes, og om varigheden af forespørgsler vises, så brugerfladen passer til dit teams præferencer.

springdoc:
  swagger-ui:
    doc-expansion: none      # collapse all by default
    display-request-duration: true

Sikring af selve brugerfladen

Swagger UI viser din API-overflade. I produktion skal du beskytte /swagger-ui/** og /v3/api-docs/** med Spring Security eller deaktivere dem, så de ikke kan gennemses offentligt.

// permit only authenticated users
http.authorizeHttpRequests(a -> a
    .requestMatchers("/swagger-ui/**", "/v3/api-docs/**").authenticated()
    .anyRequest().permitAll());

Brugerflade kontra specifikation – arbejdsfordeling

Husk: Swagger UI er kun en fremviser. Den autoritative kilde er OpenAPI-specifikationen, som genereres ud fra din kode og dine annotationer. Forbedr dokumentationen ved at forbedre annotationerne – ikke brugerfladen.

Hurtigt tjek

Bekræft din viden om Swagger UI.

Besvar den i den interaktive lektion

Opsummering

Du har udforsket Swagger UI:

Tilgås på /swagger-ui.html og bygger på /v3/api-docs
Try it out sender forespørgsler til den kørende API, og Authorize tilføjer tokens
Sortering, filtrering og udfoldning kan konfigureres via egenskaber
Beskyt eller deaktivér brugerfladen i produktion

Gratis at komme i gang

Lær Java med en AI-underviser — gratis

Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.

Kurser: 24
Lektioner: 93

Start gratis Se hele kurset

Ofte stillede spørgsmål

Er lektionen “Swagger UI” gratis?

Ja — hele teksten til “Swagger UI” kan læses gratis her på nettet. Hvis du vil øve dig interaktivt med en indbygget kodeeditor og en AI-vejleder døgnet rundt og få adgang til resten af Spring Boot 4-mikrotjenester og REST-API'er-kurset, skal du opgradere til CoddyKit PRO. Spring Boot 4-mikrotjenester og REST-API'er-kurset indeholder 4 lektioner i alt.

Hvad lærer jeg i “Swagger UI”?

Udforsk og test API'er interaktivt. Du øver dig i Spring Boot 4-mikrotjenester og REST-API'er med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.

Skal jeg have erfaring for at begynde på Spring Boot 4-mikrotjenester og REST-API'er?

Der kræves ingen tidligere erfaring. Spring Boot 4-mikrotjenester og REST-API'er på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 4 af 4.

Hvor lang tid tager lektionen “Swagger UI”?

De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.

Kan jeg skrive og køre kode i denne Spring Boot 4-mikrotjenester og REST-API'er-lektion?

Ja. Alle Spring Boot 4-mikrotjenester og REST-API'er-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.

Alle lektioner i dette kursus

← Tilbage til Spring Boot 4-mikrotjenester og REST-API'er