swagger 2 spring boot generuje plik YML


Jestem nowy, jeśli chodzi o przechwalanie się, kontrakty i pracuję nad projektem Spring boot (gradle), w którym dopiero zaczynamy z kontraktami. Użyłem Grails, podoba mi się, jak można umieścić Field Defs na domenie, a ona dziedziczy stos.
Konkretne pytanie i być może również pytanie o wyciskanie piggy back.
Jak mogę wygenerować podstawowy plik pośredniczący YAML ze standardowej klasy kontrolera?
Rozumiem, że muszę utworzyć plik [Name] - v1-0.yml w katalogu
controller \ src \ test \ resources
Zaimplementowałem swagger-ui.html w projekcie i pojawiła się naprawdę fajna interaktywna strona internetowa pokazująca punkty końcowe żądań i inne rzeczy. Użycie
klasy SwaggerConfig rozszerza WebMvcConfigurerAdapter
, który działa w celu publikowania interfejsów w interfejsie doc stron internetowych json.
Przypuszczam, że rozumiem jest to, że plik yml w katalogu zasobów testowych będzie stałą generacją "kontraktów" i będzie używany w jakiejś metodzie testowania gradle, aby upewnić się, że podpis API i punkty kontraktu nie zmieniły się jak podstawowy styl junit interfejs testowy. (Tak nie?)
Jestem leniwy i myślę sobie, dlaczego ręcznie hakuję ten głupi plik?
Czy można łatwo wygenerować szkielet dokumentu YAML na podstawie szczegółów kontrolera/modelu?
Na przykład strona pobiera plik YML i tworzy przyjazną dla interfejsu użytkownika stronę:

http://editor.swagger.io
http://editor.swagger.io/#/
/#/
Ta strona ma naprawdę dobry "uber" przykładowy plik YAML, czy naprawdę muszę to napisać, napisałem już kontroler, javadoc, z adnotacjami, wszelkiego rodzaju fajne rzeczy, które powinny być w stanie wygenerować, przynajmniej całkiem niezły starter yaml stub (winię cię Grails za to, że nie chcesz tego zhakować!) To jest oczywiście przed dodaniem adnotacji SpringFox, które robią więcej fajnych rzeczy i naprawdę idą do miasta, aby zarządzać większą liczbą testów gwarancji kontraktowej.
FYI:
'spring-boot-starter-web'
'spring-boot-starter-test'
'springfox-swagger-ui', version: '2.4.0'
Zaproszony:
Anonimowy użytkownik

Anonimowy użytkownik

Potwierdzenie od:

Zrozumiałem. To bardzo proste, dlaczego nigdzie tego nie widziałem.
Skopiuj/wklej ścieżkę do zasobu w przeglądarce:
[url=http://localhost:8095/v2/api-docs?group=full-api]http://localhost:8095/v2/api-docs?group=full-api[/url]

Wybierz wygenerowaną zawartość i skopiuj ją do schowka.
Otwórz edytor Swagger w przeglądarce:
http://editor.swagger.io
http://editor.swagger.io
Wybierz Wstaw JSON ... z menu Plik.
Wklej wygenerowaną zawartość Swagger JSON i kliknij przycisk Importuj.
Anonimowy użytkownik

Anonimowy użytkownik

Potwierdzenie od:

Istnieje żądanie funkcji, aby zapewnić reprezentację Yaml specyfikacji:

https://github.com/springfox/springfox/issues/651
https://github.com/springfox/springfox/issues/651
Oprócz postępu nie jest jeszcze dostępny.

Aby odpowiedzieć na pytania, Zaloguj się lub Zarejestruj się