Huśtawka 2-wiosenny rozruch generuje plik yml

Question

Jestem nowicjuszem w dziedzinie pracy, kontraktów i pracy nad projektem Spring boot (gradle), w którym dopiero zaczynamy od zajmowania się kontraktami. Używałem grails, uwielbiam, jak umieszczać defekty pola w domenie i jest ono dziedziczone przez stos.

Specyficzne pytanie, a może również pytanie dotyczące splatania w piggy backed.

Jak mogę wygenerować podstawowy kod pośredniczący pliku YAML ze standardowej klasy kontrolera?

Rozumiem mam stworzyć [nazwa] -v1-0.yml plik w katalogu controller\src\test\resources

I zaimplementowaniu Swagger-ui.html w projekcie i naprawdę fajne interaktywne Pojawi się strona internetowa z prośbą o podanie punktów końcowych i materiałów. Używanie funkcji class SwaggerConfig extends WebMvcConfigurerAdapter do publikowania interfejsów na stronie internetowej UJ json doc.

Uważam, że zrozumienie polega na tym, że plik yml w katalogu zasobów testowych będzie stałą generacją "umów" i użyty w pewnym rodzaju metody sprawdzania poprawności, aby upewnić się, że podpis API i punkty kontraktowe nie uległy zmianie, jak podstawowy test interfejsu w junitach. (Tak/nie?)

Jestem tu leniwy, myślę sobie, dlaczego mam hakować ten głupi plik? Czy szkielet dla yaml może być generowany dla mnie całkiem prosto z danych kontrolera/modelu?

Na przykład na stronie zajmuje plik yml i robi UI przyjazne strony: http://editor.swagger.io/#/

Jest to naprawdę bardzo miłe „uber” przykładowy plik YAML w tej stronie, czy naprawdę trzeba pisać, że ja już napisał kontroler, javadoc, napisałem adnotację, wszystkie fajne rzeczy, które powinny być w stanie wygenerować co najmniej całkiem dobry początkowy odcinek yaml, (winię was za to, że nie chcecie tego zhakować!), to oczywiście przed wstawianiem adnotacji SpringFox które robią więcej fajnych rzeczy i naprawdę jadą do miasta, by jeździć więcej w tym kontrakcie na testowanie.

FYI: 'spring-boot-starter-web' 'spring-boot-starter-test' 'springfox-swagger-ui', version: '2.4.0'

Answer 1

mam. Bardzo proste, dlaczego nigdzie tego nie widziałem. :)

Kopiuj/wklej ścieżkę zasobów w przeglądarce:

http://localhost:8095/v2/api-docs?group=full-api

Wybierz wygenerowany zawartości i kopiowania do schowka.

Otwórz Edytor Swagger w przeglądarce:

http://editor.swagger.io

Wybierz Wklej JSON ... z menu Plik.

Wklej wygenerowaną zawartość JSON Swagger i kliknij opcję Importuj.

Answer 2

Jest prośba cecha dostarczenie reprezentacji yaml o specyfikacji: https://github.com/springfox/springfox/issues/651

Poza postępem, to nie jest jeszcze dostępna