Swagger file generation on Spring Boot lambda

Aberta
  • Algo errado?
#338 2 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
30/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
aws, java, spring-boot
Domínio
api, backend, cloud

Direção de pesquisa

Comece revisando o Swagger2Config e os mapeamentos de controllers anotados descritos na issue e, em seguida, inspecione como a aplicação Spring Boot é implantada como uma Lambda. Determine se a Lambda implantada pode expor swagger-ui.html e defina um caminho de acesso verificável; considera-se concluído quando a Swagger UI estiver acessível após a implantação ou quando a limitação compatível estiver documentada.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

  • 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")
    })
Linguagem predominante
Java
Estrelas
1.6k
Forks
575
Merge médio
1d 15h
PRs com merge (30d)
12

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aws/serverless-java-container

Todas as issues de aws/serverless-java-container

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.