aws / aws/serverless-java-container

Swagger file generation on Spring Boot lambda

Offen
#338 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
1.6k
Forks
574
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

* Implementations: Spring Boot

## Scenario
I have annotated my spring boot 2 lambda with a Swagger2Config so that it auto-generates a Swagger-file for the annotated methods in the controller. Is there a way to access the swagger-ui.html after deploying the lambda? The annotated request mapping are reacheable just fine.

## Steps to reproduce
Add these maven dependencies to your spring boot 2 mvn lambda:

```

io.springfox
springfox-swagger2
2.6.1
compile


io.springfox
springfox-swagger-ui
2.6.1
compile

```
Add a Swagger2Config file and annotate the controller methods with Swagger annotations.

```
@RequestMapping(path = "/categories", method = RequestMethod.POST)
@ApiOperation(value="Add a new category",response=Category.class)
@ApiResponses(value={
@ApiResponse(code=200,message="Category created successfully",response=Category.class, responseContainer="List"),
@ApiResponse(code=500,message="Internal server error")
})
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die im Issue beschriebenen Swagger2Config- und annotierten Controller-Zuordnungen zu prüfen, und untersuche anschließend, wie die Spring-Boot-Anwendung als Lambda bereitgestellt wird. Ermittle, ob die bereitgestellte Lambda swagger-ui.html bereitstellen kann, und definiere einen überprüfbaren Zugriffspfad; als erledigt gilt die Aufgabe, wenn die Swagger UI nach der Bereitstellung erreichbar ist oder die unterstützte Einschränkung dokumentiert wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
aws, java, spring-boot
Bereich
api, backend, cloud
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.