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

Tilføj SpringDoc til Deres projekt

Generér OpenAPI-dokumentation automatisk.

Lektion 1 af 413 trin

Tilføj SpringDoc til Deres projekt er en gratis Spring Boot 4-mikrotjenester og REST-API'er-lektion på CoddyKit. Dette er lektion 1 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.

Hvorfor skal du dokumentere din API?

En API uden dokumentation er svær at bruge. OpenAPI (tidligere Swagger) er en standardiseret, maskinlæsbar beskrivelse af din REST API, som danner grundlag for interaktiv dokumentation, generering af klienter og kontrakttest.

Hvad SpringDoc gør

SpringDoc OpenAPI inspicerer dine Spring-controllere under kørsel og genererer automatisk OpenAPI-specifikationen – du behøver ikke skrive YAML i hånden.

Læs dine @RestController-mappinger
Leverer specifikationen og en Swagger UI

Tilføj starteren (Maven)

Tilføj afhængigheden springdoc-openapi-starter-webmvc-ui. Varianten med -ui indeholder både Swagger UI og JSON-specifikationen.

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.6.0</version>
</dependency>

Tilføj starteren (Gradle)

Gradle-koordinaterne er det samme artefakt.

implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0"

WebMVC kontra WebFlux

Vælg den starter, der passer til din stack:

Servlet-apps -> springdoc-openapi-starter-webmvc-ui
Reaktive apps -> springdoc-openapi-starter-webflux-ui

Ingen konfiguration nødvendig for at komme i gang

Med kun afhængigheden skal du starte appen, hvorefter SpringDoc konfigurerer alt automatisk. Du får straks den genererede specifikation og brugerflade uden at skrive kode.

Det genererede JSON-endpoint

Det rå OpenAPI-dokument leveres som standard på /v3/api-docs. Denne JSON kan bruges af kodegeneratorer, Postman eller API-gateways.

// GET http://localhost:8080/v3/api-docs
// returns the full OpenAPI 3 JSON document

Swagger UI-endpointet

Den interaktive brugerflade findes på /swagger-ui.html. Den viser hvert endpoint og lader dig afprøve forespørgsler i browseren.

// open http://localhost:8080/swagger-ui.html

Ændring af standardstierne

Du kan flytte specifikationen og brugerfladen via egenskaber, hvilket er nyttigt bag en gateway eller for at undgå kollisioner.

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

Det, der registreres automatisk

SpringDoc udleder meget uden annotations: stier, HTTP-metoder, sti- og forespørgselsparametre, skemaer for forespørgsels- og svarlegemer fra dine DTO-klasser samt statuskoder for svar.

Deaktivering i produktion (valgfrit)

Nogle teams eksponerer kun dokumentation i miljøer, der ikke er produktion. Slå det til eller fra med egenskaber, så specifikationen og brugerfladen ikke leveres i produktionen.

# disable everywhere
springdoc:
  api-docs:
    enabled: false
  swagger-ui:
    enabled: false

Hurtigt tjek

Bekræft det grundlæggende i at tilføje SpringDoc.

Besvar den i den interaktive lektion

Opsummering

Du har sat API-dokumentation op:

SpringDoc genererer OpenAPI-specifikationen ud fra dine controllere
Tilføj springdoc-openapi-starter-webmvc-ui (eller webflux)
Specifikation på /v3/api-docs, brugerflade på /swagger-ui.html
Stier og aktivering kan konfigureres via egenskaber

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 “Tilføj SpringDoc til Deres projekt” gratis?

Ja — hele teksten til “Tilføj SpringDoc til Deres projekt” 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 “Tilføj SpringDoc til Deres projekt”?

Generér OpenAPI-dokumentation automatisk. 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 1 af 4.

Hvor lang tid tager lektionen “Tilføj SpringDoc til Deres projekt”?

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