Swagger file generation on Spring Boot lambda

Abierto
  • ¿Algo no está bien?
#338 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
aws, java, spring-boot
Área
api, backend, cloud

Línea de trabajo

Comienza revisando Swagger2Config y las asignaciones de controladores anotadas descritas en el issue; después, inspecciona cómo se implementa la aplicación Spring Boot como una Lambda. Determina si la Lambda implementada puede exponer swagger-ui.html y define una ruta de acceso verificable; se considera completado cuando Swagger UI es accesible después de la implementación o se documenta la limitación admitida.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

  • 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:

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
            <scope>compile</scope>
        </dependency>

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")
    })
Lenguaje dominante
Java
Estrellas
1.6k
Forks
575
Merge medio
1 d 15 h
PR fusionados (30 d)
12

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aws/serverless-java-container

Todos los issues de aws/serverless-java-container

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.