Einleitung
Aktuell arbeite ich an einem größeren Kundenprojekt. Eine Anforderung war die Dokumentation des REST-Dienstes, wofür wir Swagger gewählt haben.
Swagger bietet Möglichkeiten, REST-Dienste und ihre APIs zu dokumentieren. Beim Deployment mit dem Swagger Maven Plugin von kongchen trat folgende Fehlermeldung auf:
Fehlermeldung
Failed to execute goal com.github.kongchen:swagger-maven-plugin:1.1.2:generate (default) on project encrypted-project-name: null: MojoExecutionException: NullPointerException -> [Help 1]
To see the full stack trace of the errors, re-run Maven with the -e switch.
Re-run Maven using the -X switch to enable full debug logging.
For more information about the errors and possible solutions, please read the following articles:
[Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
Leider war die Meldung wenig aussagekräftig und enthielt weder Details zur Ursache noch zur betroffenen Zeile.
Resource-Klasse
Meine Resource-Klasse sah ungefähr so aus:
@Component
@Path("/report")
@Api(value = "/report", description = "Reporting")
public class ReportResource {
private static final Logger LOG = LoggerFactory.getLogger(ReportResource.class);
@Autowired
ReportService reportService;
@GET
@Path("/report")
@Produces(MediaType.APPLICATION_JSON)
public List<Report> getReport() {
return reportService.getReport();
}
}
Lösung
Das Problem liegt an der Annotation @Api. Gibt es keine mit @ApiOperation annotierte Methode, erzeugt Maven die oben genannte Exception. Es gibt zwei Möglichkeiten:
Entweder wird @Api von der Klasse entfernt – was bei gewünschter API-Dokumentation nicht sinnvoll ist – oder die Methode erhält @ApiOperation. Letzteres behebt das Problem.
In meinem Fall sah die Lösung so aus:
@Component
@Path("/report")
@Api(value = "/report", description = "Reporting")
public class ReportResource {
private static final Logger LOG = LoggerFactory.getLogger(ReportResource.class);
@Autowired
ReportService reportService;
@GET
@Path("/report")
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Retrieve report")
public List<Report> getReport() {
return reportService.getReport();
}
}