SpringCloud / SpringBoot - API belgelerini otomatik olarak oluşturun
SpringCloud / SpringBoot projesi önden ve arkadan ayrılmalıdır. Bu, API dokümantasyonu oluşturmak için bir araç gerektirir. Arka uç, ön uca veya mobil terminale bağlanmalıdır. O halde soru, arayüz onlar için yazılmalı mıdır? Yazmak için Excel veya Word kullanabilirim ve gelişmiş olanlar API yönetim platformu kullanılarak manuel olarak girilir. Bir proje on binlerce arayüze sahiptir. Aman Tanrım, bu ne kadar iş ve arayüzü korumak daha zahmetli. Çözmek için Bu tür şeyler için, tamamen ek açıklama oluşturmaya dayanan otomatik RESTFul belgeleri oluşturma işlemini tamamlamak için japi projesini kullanabiliriz.Daha ayrıntılı yapılandırma için lütfen açık kaynak projesine https://github.com/dounine/japi bakın.
Kullanım için talimatlar
Projeyi aşağı klonlayın
git klon https://github.com/dounine/japi.gitDerleyin ve paketleyin
cd japi / java gradle install -xtestÇalıştırmak JAPI Sahne arkası yönetimi
cd japi / java gradle bootRunÇalıştırmak JAPI Belge arayüzü
cd japi / düğümü düğüm app.jsRESTFul belgesi oluştur
maven projesi
< bağımlılık > < Grup kimliği > com.dounine.japi < /Grup kimliği > < artifactId > müşteri < / artifactId > < versiyon > 1.0 < / version > < /bağımlılık >gradle projesi
derleme grubu: 'com.dounine.japi', ad: 'istemci', sürüm: '1.0'Resources / japi.properties yapılandırma dosyasını düzenleyin
japi.name = test japi.uuid = 43a600877430438596de3d330e4bd06e japi.version = 1.0.0 japi.author = göl japi.url = http: //192.168.0.123: 8080 japi.description = bu proje açıklamasıdır. japi.createTime = 2017-02-2310:44:44 japi.icon = / home / lake / github / japi / html / img / logo.png japi.server = http: //192.168.0.179: 7778 japi.server.username = japi japi.server.password = japi123Bir eylem yazın
/ ** * Kullanıcı listesini alın * @param kullanıcı kullanıcı bilgileri * @return class Kullanıcısı * @ sürüm v2 * / @GetMapping (value = "v2 / list") public Result hots (@Validated ({User.UserDEL.class}) Kullanıcı kullanıcı) RuntimeException { boş döndür; }Bir API oluşturma sınıfı yazın
JapiCreateTest.java
@Ölçek public void testCreate () { JapiClient.setPrefixPath ("/ home / lake / github / test-japi / java /"); // Proje yolu öneki JapiClient.setpostfixPath ("/ src / main / java"); // Proje yolu soneki JapiClient.setProjectJavaPath ("client"); // Ana proje JapiClient.setActionReletivePath ("com / dounine / test-japi / action"); // ana proje eylem paketinin yoluna göre //JapiClient.setIncludeProjectJavaPath(new String {"api"}); // Ana projeyle ilişkili diğer proje paketi yolları JapiClient.setIncludePackages (new String {"com.dounine.test-japi"}); // Doğru ve hızlı arama için ilişkili paketler JapiClient.saveHistory (true); // Yerel geçmiş sürümünün saklanıp korunmayacağı JapiClient.setFlushServer (false); // Yerel ve sunucunun tüm sürümlerini senkronize etmeye zorlandı (önce sunucunun önceki geçmiş sürümü silinecek) IProject projesi = ProjectImpl.init (); JapiClientStorage japiClientStorage = JapiClientStorage.getInstance (); japiClientStorage.setProject (proje); japiClientStorage.autoSaveToDisk (); // Yerel diski otomatik olarak kullanın == > Kullanıcı dizini / .japi-client / new JapiClientTransfer (). autoTransfer (japiClientStorage); // Ana sunucuya dosya transferi. }Son olarak http: // localhost: 7777 tarayıcısını ziyaret edin
RESTFul belge girişini görebilirsiniz
Tüm öğeleri görmek için kendi hesabınızla giriş yapın
Ayrıntılı RESTFul arayüzünü görmek için projeye girin
kullanılacak sahneler
JAPI, SpringCloud gibi dağıtılmış çok modüllü projelerde kullanım için en uygun olanıdır. Kod yorumlarını daha standart hale getirecek yerleşik güçlü normal ifadelere sahiptir. Doküman oluşturmak için müdahaleci ek açıklamalar kullanan Swigger'dan farklıdır. JAPI tamamen standart notlara dayanır. Evet, güçlü JSR303 veya özel ek açıklamaları destekler.
Açık kaynak ruhu
JAPI tamamen açık kaynaktır
Sonunda
Her gün daha yeni ve içerikli teknik makaleler yayınlayın, her zaman size uygun bir tane vardır.
Çabuk takip et beni, paketle beni.
