aws / aws/serverless-java-container
Swagger file generation on Spring Boot lambda
- Linguagem predominante
- Java
- Estrelas
- 1.6k
- Forks
- 574
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
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:
```
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")
})
```
Guia de contribuição
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.
Avaliação
- Stack de tecnologia
- aws, java, spring-boot
- Domínio
- api, backend, cloud
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 30/100