spring-projects / spring-projects/spring-data-rest

Swagger support [DATAREST-410]

Open
#787 2 comments 0 reactions 1 assignee View on GitHub

@odrotbohm is already working on this.

Since Dec 31, 2020.

type: enhancement
Dominant language
Java
Stars
958
Forks
568
PR merge metrics
No merged PRs in 30d

Description

Adrian Kelly opened DATAREST-410 and commented

I'm one of the core contributors on swagger-springmvc (https://github.com/martypitt/swagger-springmvc). We've had some requests to support SDR (https://github.com/martypitt/swagger-springmvc/issues/238) and was wondering how we might go about this. Right now we infer the paths, parameter types, model types and other meta data from a combination of Spring MVC's RequestMappingHandlerMapping's, HandlerMethod's and a number of the org.springframework.web.bind.annotation annotations applied to controllers. Wondering if it is possible to hook into SDR to infer the same type of information needed for swagger? Does SDR maintain a cache of the api paths, their parameters and returned models types?


2 votes, 4 watchers

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.