Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(rest): generate OpenAPI docs for ProjectController #2071

Merged
merged 1 commit into from
Aug 11, 2023

Conversation

GMishx
Copy link
Member

@GMishx GMishx commented Jul 28, 2023

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. The EntityModel class of spring-hateoas uses @JsonUnwrapped to unwrap the content from Jackson. Need to understand how to make springdoc understand this and unwrap the content for OpenAPI doc.

@GMishx GMishx force-pushed the doc/api/openapi branch 3 times, most recently from d8740cf to 91481a5 Compare July 28, 2023 14:58
@GMishx GMishx changed the title doc(rest): generate openapi docs for ProjectController docs(rest): generate OpenAPI docs for ProjectController Jul 28, 2023
@heliocastro heliocastro self-requested a review July 28, 2023 17:45
@heliocastro
Copy link
Contributor

@GMishx Looking on the build failure, seen like a good way to detect some endpoint issues. I honestly like your idea

@ag4ums ag4ums added the WIP work in progress label Jul 31, 2023
Use `org.springdoc.springdoc-openapi-ui` to generate openAPI docs as
well as swagger UI.

Signed-off-by: Gaurav Mishra <gmishx@gmail.com>
@GMishx GMishx removed the WIP work in progress label Aug 11, 2023
Copy link
Contributor

@heliocastro heliocastro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants