Springboot, RESTful API belgeleri oluşturmak için swagger2'yi entegre eder

1. Resmi adres: https://swagger.io/

2. El yazısıyla yazılmış Api belgelerinin birkaç acı noktası: Belgenin güncellenmesi gerektiğinde, yeniden ön uca gönderilmesi gerekir, yani belge güncelleme iletişimi zamanında değildir. Arayüz dönüş sonucu net değil Arayüzü doğrudan çevrimiçi olarak test edemezsiniz.Genellikle araçları kullanmanız gerekir.Örneğin, çok fazla postacı arayüz dokümanı var ve yönetimi zor.

Swagger bu problemi çözmektir.Dokümanlar bazı konfigürasyonlarla oluşturulabilir.Elbette Swagger'ın mükemmel olması gerektiği söylenemez.Tabii ki dezavantajları da var.Bunlardan en bariz olanı, kodun nispeten güçlü olmasıdır.

3. Bir bakışta API:

4. SpringMVC yapılandırması Swagger2: Öncelikle bir Spring + SpringMVC projeniz var, ardından yapılandırmaya devam edin:

4.1 Pom.xml yapılandırmaya devam eder:

4.2 Proje paket adının com.naton olduğunu varsayalım Bir klasör oluşturun: com.naton.conf conf dizininde bir dosya oluşturun: SwaggerConfig.java: Kod:

4.3 swagger-ui.html'ye erişmek için, bu statik kaynaklara erişimi yapılandırıyoruz ve bir dosya oluşturuyoruz: WebAppConfig.java

4.4 Test adresi: http: // localhost: bağlantı noktası / proje adı / swagger-ui.html

4.5 Arayüz yapılandırması:

Misal:

5. Dikkat edilecek noktalar:

Swagger2 belgesinin bir geliştirme ortamında kullanılması önerilir.Üretim ortamının yorumlanması veya oturum açma işleminin arkasına gizlenmesi gerekir.

6. springBoot yapılandırması Swagger2 işlemi, SpringMVC yapılandırmasına benzer:

Pom.xml yapılandırması, yeni bir dosya yapılandırmasında yukarıda sunulan maven kitaplığıyla aynıdır:

3199 yuan'da OnePlus 6: Liu Zuohu'nun gözündeki en iyi amiral gemisi
önceki
Tamsayı türü olup olmadığını belirlemenin beş js yolu
Sonraki
Real Madrid Genç Takımı şampiyonluğu namağlup kazandı, Marcelonun en büyük oğlu bu sezon 24 gol attı
Livingston bir toka verdi, Curry bunu görünce yere "çöktü"
XpressMusic devamı Nokia X6 National Bank yeni makinesi çıktı
Lenovo gerçekleri açıkladı: Samsung ve Huawei'ye oy verdi, ancak Qualcomm'a oy vermedi
Sahtecilikle mücadele ders kitabı, Mainz'in sahip olma oranı% 30'dan az ve yine de Freiburg'u 5-0 yendi
IOS, ZipperDown güvenlik açığını ortaya çıkarıyor, popüler uygulamaların neredeyse tamamı hit
Java's Filter, aop programlama düşüncesinin bir uygulaması
Bu bir devin omzu! Alibaba'nın 2018'de açtığı harika projelerin özeti
Wang Xiaolu: Gereksiz hükümet harcamalarını azaltmak ve kurumlar vergisi indirimi ile el ele gitmek
Arka arkaya üç yolcu için ilk durak! Sixers, Minnesota'ya doğru yola çıkacak
Baba oğul askerler! Barea atış alıştırması yaptı ve oğlu topu sepetin altından aldı.
OnePlus 6 amiral gemisi yüksek çözünürlüklü görüntülemeler yayınlandı, artık OPPO değil
To Top