docs(rest): generate OpenAPI docs for ProjectController #2071
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use
org.springdoc.springdoc-openapi-ui
to generate openAPI docs as well as swagger UI.New dependencies:
How To Test?
Known issue
hateoas responses for all endpoints put properties of the class inside
content
. TheEntityModel
class of spring-hateoas uses@JsonUnwrapped
to unwrap the content from Jackson. Need to understand how to make springdoc understand this and unwrap thecontent
for OpenAPI doc.