lauhin
10/15/2019 - 6:27 PM

Zenito swagger library gebruiken

Zenito swagger library gebruiken

Maven dependency

<dependency>
    <groupId>be.zenito.utils</groupId>
    <artifactId>swagger</artifactId>
    <version>1.0.0</version>
</dependency>

Onderstaande code toevoegen aan de \ tag in de pom.xml. Dit is nodig zodat maven variabelen beschikbaar worden in . properties bestanden.

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
    </resource>
</resources>

ComponentScan

Door deze code toe te voegen wordt swaggercode beschikbaar voor deze applicatie. Zowel swagger package als de base package van ons project moet erin. Niet in application.java want anders falen de tests

@ComponentScan({"be.zenito.utils.swagger"})

Properties

bootstrap.properties

swagger.application.name=@project.artifactId@
swagger.application.version=@project.version@
swagger.application.description=@project.description@
swagger.controller.package=be.zenito.services.kbolog.controller

bootstrap-local/dev/test.properties

Enkel lokaal, op dev en test wordt swagger aangezet. Zodat er op accept en productie geen acties kunen gebeuren via swagger. In de andere .properties moet deze parameter niet toegevoegd worden (ze staat standaard op false).

swagger.enable=true

Test errors

Als er test errors verschijnen moet je de @ComponentScan ergens anders plaatsen