Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät · Oppitunti

SpringDocin lisääminen projektiin

Luokaa OpenAPI-dokumentaatio automaattisesti.

Oppitunti 1/413 vaihetta

SpringDocin lisääminen projektiin on ilmainen Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-oppitunti CoddyKitissä. Tämä on oppitunti 1/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-kurssilla on yhteensä 4 oppituntia.

Miksi API kannattaa dokumentoida?

Ilman dokumentaatiota API:a on vaikea käyttää. OpenAPI (aiemmin Swagger) on REST-API:n standardoitu, koneellisesti luettava kuvaus, jonka avulla voidaan tuottaa vuorovaikutteinen dokumentaatio, asiakasohjelmia ja sopimustestejä.

SpringDocin toiminta

SpringDoc OpenAPI tarkastelee Spring-ohjaimia suorituksen aikana ja luo OpenAPI-määrityksen automaattisesti – YAML-tiedostoa ei tarvitse kirjoittaa käsin.

Lukee @RestController-määritykset
Tarjoaa määrityksen ja Swagger UI:n

Starterin lisääminen (Maven)

Lisätkää riippuvuus springdoc-openapi-starter-webmvc-ui. -ui-versio sisältää Swagger UI:n sekä JSON-määrityksen.

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

Starterin lisääminen (Gradle)

Gradlen koordinaatit viittaavat samaan artefaktiin.

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

WebMVC vai WebFlux

Valitkaa käyttämäänne pinoa vastaava starter:

Servlet-sovellukset -> springdoc-openapi-starter-webmvc-ui
Reaktiiviset sovellukset -> springdoc-openapi-starter-webflux-ui

Käyttöönotto ilman määrityksiä

Kun riippuvuus on lisätty, käynnistäkää sovellus, niin SpringDoc määrittää kaiken automaattisesti. Saatte heti luodun määrityksen ja käyttöliittymän kirjoittamatta koodia.

Luotu JSON-päätepiste

Raaka OpenAPI-dokumentti tarjotaan oletusarvoisesti osoitteessa /v3/api-docs. Tätä JSON-dataa voivat käyttää koodigeneraattorit, Postman tai API-yhdyskäytävät.

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

Swagger UI -päätepiste

Vuorovaikutteinen käyttöliittymä on osoitteessa /swagger-ui.html. Se luettelee kaikki päätepisteet ja mahdollistaa pyyntöjen kokeilemisen selaimessa.

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

Oletuspolkujen muuttaminen

Voitte siirtää määrityksen ja käyttöliittymän toisiin polkuihin ominaisuuksien avulla. Tämä on hyödyllistä yhdyskäytävän takana tai päällekkäisyyksien välttämiseksi.

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

Automaattisesti tunnistettavat tiedot

SpringDoc päättelee ilman annotaatioita monia tietoja: polut, HTTP-metodit, polku- ja kyselyparametrit, pyyntöjen ja vastausten rungon skeemat DTO-luokista sekä vastausten tilakoodit.

Poistaminen käytöstä tuotannossa (valinnainen)

Jotkin tiimit tarjoavat dokumentaation vain tuotannon ulkopuolella. Muuttakaa asetuksia niin, ettei määritystä ja käyttöliittymää tarjota tuotannossa.

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

Pikatarkistus

Varmistakaa SpringDocin lisäämisen perusteet.

Vastaa interaktiivisessa oppitunnissa

Kertaus

Otitte API-dokumentaation käyttöön:

SpringDoc luo OpenAPI-määrityksen ohjaimista
Lisätkää springdoc-openapi-starter-webmvc-ui (tai webflux)
Määritys on osoitteessa /v3/api-docs ja käyttöliittymä osoitteessa /swagger-ui.html
Polkuja ja käyttöönottoa voi määrittää ominaisuuksien avulla

Aloita maksutta

Opi Java tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 24
Oppitunnit: 93

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”SpringDocin lisääminen projektiin” ilmainen?

Kyllä – oppitunnin ”SpringDocin lisääminen projektiin” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-kurssin, päivitä CoddyKit PROhon. Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”SpringDocin lisääminen projektiin”?

Luokaa OpenAPI-dokumentaatio automaattisesti. Harjoittelet Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 1/4.

Kuinka kauan ”SpringDocin lisääminen projektiin”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-oppitunnilla?

Kyllä. Jokainen Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

← Takaisin: Spring Boot 4 -mikropalvelut ja REST-sovellusliittymät