Projenize SpringDoc Ekleme
OpenAPI belgelerini otomatik olarak oluşturun.
Projenize SpringDoc Ekleme, CoddyKit'te ücretsiz bir Spring Boot 4 Microservices & REST APIs dersidir. Bu, 4 dersinin 1. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, Spring Boot 4 Microservices & REST APIs öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. Spring Boot 4 Microservices & REST APIs kursu toplamda 4 dersten oluşur.
Bu dersin bazı bölümleri henüz çevrilmemiş olup İngilizce olarak gösterilmektedir.
Why document your API?
An API without docs is hard to consume. OpenAPI (formerly Swagger) is a standard, machine-readable description of your REST API that powers interactive docs, client generation and contract testing.
What SpringDoc does
SpringDoc OpenAPI inspects your Spring controllers at runtime and generates the OpenAPI spec automatically - no hand-written YAML needed.
- Reads your
@RestControllermappings - Serves the spec and a Swagger UI
Adding the starter (Maven)
Add the springdoc-openapi-starter-webmvc-ui dependency. The -ui variant bundles Swagger UI as well as the JSON spec.
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.6.0</version>
</dependency>Adding the starter (Gradle)
The Gradle coordinates are the same artifact.
implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0"WebMVC vs WebFlux
Pick the starter matching your stack:
- Servlet apps ->
springdoc-openapi-starter-webmvc-ui - Reactive apps ->
springdoc-openapi-starter-webflux-ui
Zero config to start
With just the dependency, start the app and SpringDoc auto-configures everything. You immediately get the generated spec and UI without writing any code.
The generated JSON endpoint
The raw OpenAPI document is served at /v3/api-docs by default. This JSON can feed code generators, Postman, or API gateways.
// GET http://localhost:8080/v3/api-docs
// returns the full OpenAPI 3 JSON documentThe Swagger UI endpoint
The interactive UI is at /swagger-ui.html. It lists every endpoint and lets you try requests in the browser.
// open http://localhost:8080/swagger-ui.htmlChanging the default paths
You can relocate the spec and UI via properties, useful behind a gateway or to avoid collisions.
# application.yml
springdoc:
api-docs:
path: /api-docs
swagger-ui:
path: /docs.htmlWhat gets detected automatically
SpringDoc infers a lot with no annotations: paths, HTTP methods, path/query params, request and response body schemas from your DTO classes, and response status codes.
Disabling in production (optional)
Some teams expose docs only in non-prod. Toggle with properties so the spec and UI are not served in production.
# disable everywhere
springdoc:
api-docs:
enabled: false
swagger-ui:
enabled: falseQuick Check
Confirm the basics of adding SpringDoc.
Recap
You bootstrapped API docs:
- SpringDoc generates the OpenAPI spec from your controllers
- Add
springdoc-openapi-starter-webmvc-ui(or webflux) - Spec at
/v3/api-docs, UI at/swagger-ui.html - Paths and enablement are configurable via properties
Sıkça Sorulan Sorular
“Projenize SpringDoc Ekleme” dersi ücretsiz mi?
Evet — “Projenize SpringDoc Ekleme” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve Spring Boot 4 Microservices & REST APIs kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. Spring Boot 4 Microservices & REST APIs kursu toplamda 4 dersten oluşur.
“Projenize SpringDoc Ekleme” dersinde ne öğreneceğim?
OpenAPI belgelerini otomatik olarak oluşturun. Spring Boot 4 Microservices & REST APIs ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.
Spring Boot 4 Microservices & REST APIs öğrenmeye başlamak için deneyim gerekli mi?
Önceden deneyim gerekmez. CoddyKit'te Spring Boot 4 Microservices & REST APIs, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 1. dersidir.
“Projenize SpringDoc Ekleme” dersi ne kadar sürer?
Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.
Bu Spring Boot 4 Microservices & REST APIs dersinde kod yazıp çalıştırabilir miyim?
Evet. Her Spring Boot 4 Microservices & REST APIs dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.
Bu kursun tüm dersleri
- Projenize SpringDoc Ekleme
- Uç Noktaları ve Modelleri Belgeleme
- OpenAPI Belirtimini Özelleştirme
- Swagger UI