portur.top

  

Bästa artiklarna:

  
Main / Vad är swagger ui jar

Vad är swagger ui jar

Springfox-paketet med java-bibliotek handlar om att automatisera generationen av maskin- och mänskliga läsbara specifikationer för JSON API: er skrivna med hjälp av vårfamiljen av projekt. Springfox fungerar genom att undersöka en applikation en gång vid körning för att härleda API-semantik baserat på vårkonfigurationer, klassstruktur och olika kompileringstid java-kommentarer. Springfox har utvecklats från ett projekt som ursprungligen skapades av Marty Pitt och fick namnet swagger-springmvc.

Mycket kudos går till Marty. Att utöka stödet för andra fjäderteknologier än vår webbmvc. Filosofiskt vill vi avskräcka med att använda swagger-core-kommentarer som inte är väsentliga för tjänstebeskrivningen vid körning.

Främre del. InteNull eller specificera RequestParam krävs bör alltid vinna. För att publicera den aktuella ögonblicksbilden för dokumentationen. Rekommendera att använda [autoenv] https: Utgivningsstegen är som följer: För att kringgå standardutgivningsflödet och ladda upp direkt till bintray, använd följande uppgift - ställ in versionen manuellt i version. Se wiki för några riktlinjer. Om du hittar problem eller fel kan du skicka dem via Springfox Github-projektet.

Springfox-biblioteken är värd på bintray och jcenter. Artefakterna kan ses på följande platser :.

Springfox har flera moduler och beroenden varierar beroende på önskad API-specifikationsstandard. Nedan beskrivs hur du kan inkludera springfox-swagger2-modulen som producerar Swagger 2. Det finns många fler alternativ för att konfigurera Docket. Detta bör ge en bra start. Importera konfigurationen från springfox-data-rest-modulen via Java eller xml config som visas nedan. I version större än 2.

Springfox-swagger-ui webburken levereras med Swagger UI. För att inkludera det i en standard Spring Boot-applikation kan du lägga till beroendet enligt följande :. Att dra in beroendet skapar en webjar som innehåller det statiska innehållet för swagger-ui. Swagger UI-sidan bör då vara tillgänglig på http: Swagger ui-versionen anges i. Allt innehåll serveras från en webjar-konvention, relativ webbadress i följande form: Som standard har Spring Boot förnuftiga standardinställningar för att visa innehåll från webjars.

För att konfigurera vanilla spring web mvc-appar för att tjäna webjar-innehåll, se webjar-dokumentationen. Swagger-Ui som levereras med springfox använder meta-urls för att konfigurera sig själv och upptäcka dokumenterade slutpunkter. Webbadresserna för upptäckten är som visas nedan. Eftersom swagger ui är en statisk resurs måste den förlita sig på kända slutpunkter för att konfigurera sig vid körning. Det finns en viss anpassning som är möjlig, men swagger-ui måste vara tillgängligt i roten till webbkontext. Beträffande var själva swagger-ui serveras och var api docs serveras är de helt konfigurerbara.

Lägg till springfox-swagger-ui-rfc6570 istället för springfox-swagger-ui som ett beroendeförsök experimentellt swagger-ui. Aktivera webbadressmallning; se 21. Den nuvarande implementeringen ger dokumentation för dina slutpunkter, så långt som möjligt automatiskt, baserat på analys av statisk kod. Eftersom de ultimata http-svaren i vårintegration inte kan bestämmas statiskt från en http-inkommande slutpunkt, använder vi spring-restdocs för att ge exempel på svarskroppar.

Vi betraktar stödet som experimentellt eftersom det inte har testats med ett brett utbud av fjäderintegrationsapplikationer och eftersom vi bara har börjat utvärdera de möjligheter vi har med vår-restdocs. Beroende på vilken webbteknik du väljer måste du inkludera lämpligt springfox-spring-integration-webflux eller springfox-spring-integration-webmvc-beroende och använda respektive verktyg för att producera dokumentation för dina http-svar baserat på vår-restdocs.

Se readme för springfox-spring-integration-webmvc och springfox-spring-integration-webflux för mer information. Användarens bidragsexempel använder OAuth2 och kakbaserad autentisering i webbläsaren.

Springfox-demosförvaret innehåller ett antal prover. När vi började arbeta med 2. Så bestämde vi oss för att ta ett steg tillbaka och dela upp det i en tvåstegsprocess. Förleda först servicemodellen till en intern representation. För det andra skapa ett kartläggningsskikt som kan mappa de interna modellerna till olika specifikationsformat.

Utanför lådan stöder vi swagger 1. Springfox stöder båda versionerna 1. Om möjligt, Swagger 2. Swagger-core-anteckningarna, som tillhandahålls av swagger-core, används vanligtvis för att dekorera Java-källkoden för ett API som att vara "swaggered". Springfox är medveten om Swagger-Core-anteckningarna och kommer att gynna dessa anteckningar framför slutsatser. En stor skillnad mellan de två swagger-specifikationerna är sammansättningen av den genererade swagger-dokumentationen.

Med Swagger 1. With Swagger 2. Här är en guide som hjälper dig med övergången från 1. Legacy-dokumentation finns här. Springfox-demosförvaret innehåller ett antal exempel på vårapplikation som kan användas som referens. För att möjliggöra stöd för swagger-specifikation 1. För att aktivera support för swagger-specifikation 2. För att dokumentera tjänsten använder vi en Docket. Detta ändras för att vara mer i linje med det faktum att uttrycka innehållet i dokumentationen är agnostiskt för det format som dokumentationen återges.

Docket står för En sammanfattning eller annan kortfattad redogörelse för innehållet i ett dokument; ett abstrakt. Docket hjälper till att konfigurera en delmängd av tjänsterna som ska dokumenteras och grupperar dem efter namn. Betydande förändringar i detta är förmågan att tillhandahålla ett uttrycksfullt predikat baserat på api-val. Ett enkelt sätt att konfigurera objektmapparen är att lyssna efter ObjectMapperConfigured-händelsen.

Oavsett om det finns en anpassad ObjectMapper i spel med en motsvarande MappingJackson2HttpMessageConverter, har biblioteket alltid en konfigurerad ObjectMapper som är anpassad för att serieera swagger 1. Händelsen har ett handtag till ObjectMapper som konfigurerades. Konfigurera applikationsspecifika ObjectMapper-anpassningar i denna applikationshändelsehanterare garanterar att applikationsspecifika anpassningar kommer att tillämpas på varje ObjectMapper som spelas.

Om du stöter på en NullPointerException under programstart så här problemet. Dessa adaptrar, särskilt i scenarier som inte kommer från fjäderstart, laddas bara om EnableWebMvc-anteckningen finns.

Förbehållet för att använda biblioteket är att det beror på Jackson för serialisering, ännu viktigare ObjectMapper. Ett bra exempel på var detta går sönder är följande problem när du använder Gson-serialisering.

För att anpassa dessa slutpunkter kan det hända att egenskaperna åsidosätts genom att ladda en egenskapskälla med följande egenskaper.

Fastigheten att använda är springfox. Detta är standardvärdet, som automatiskt börjar söka efter slutpunkter när vårkontexterna uppdateras.

Den här inställningen börjar bara söka efter slutpunkter när Lifecycle start-metoden uttryckligen anropas. Det här är mycket användbart för ramverk som grails som har sin egen livscykel.

Det indikerar att biblioteksanvändaren är ansvarig för att starta livscykeln DocumentationPluginsBootStrapper. Lagt till stöd för att lösa egenskaper i fastighetskällor för att ersätta uttryck i vissa kommentarer. För att använda det definierar du helt enkelt egenskaper i applikationen. Om ingen hittas, kommer det att återge det oupplösta uttrycket som det är. Med hjälp av ApiModelProperty dataType kan vi åsidosätta de härledda datatyperna. Det är dock begränsat till att endast tillåta datatyper att anges med ett fullt kvalificerat klassnamn.

Denna konfigurationsklass måste sedan definieras i ditt xml-applikationskontext. Börjar med 2. Följande anteckningar attribut stödja beskrivning upplösning. För att tillhandahålla dessa egenskaper via externa egenskaper, lägg bara till den i din applikationsegenskapsfil eller någon egenskapskälla som konfigurerats av programmet som visas nedan. När en fastighetsplatshållare inte kan hittas är standardbeteendet att eka uttrycket som det är. En swagger-grupp är ett koncept som introduceras av detta bibliotek som helt enkelt är en unik identifierare för en Swagger Resource Listing i din applikation.

Anledningen till att detta koncept introducerades var att stödja applikationer som kräver mer än en resurslista. Varför skulle du behöva mer än en resurslista? I de flesta fall behöver en applikation inte mer än en resurslista och begreppet swagger-grupper kan ignoreras.

Som definierad operationId introducerades i Swagger 2. Detta fält används ofta av konsumenter av en Swagger 2. Ett exempel på detta kan ses i projektet swagger-codegen. Som standard, när du använder Springfox i Swagger 2. Om du vill åsidosätta standardoperationenId som Springfox återger, kan du göra det genom att ange smeknamnelementet i en ApiOperation-kommentar.

(с) 2019 portur.top