Optimize: add spring doc for generating the open api docs #156
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…dev/springboot3_springdoc
|
@orende cloud you help to review it? |
1 similar comment
|
@orende cloud you help to review it? |
orende
reviewed
Feb 17, 2025
| @@ -54,4 +54,4 @@ You can use cURL to send the request using an JSON file for the body: | |||
| -H 'Content-Type: application/json;charset=UTF-8' \ | |||
| http://localhost:8080/dddsample/handlingReport | |||
|
|
|||
| See the [api-docs.yaml](/api-docs.yaml) file for a complete API definition. | |||
| open http://127.0.0.1:8080/dddsample/swagger-ui/index.html for a complete API definition. | |||
There was a problem hiding this comment.
Wouldn't localhost work instead of 127.0.0.1 here?
|
Hello! We're going to respectfully decline this PR as the addition of a dependency to auto-generate OpenAPI spec files feels unnecessary in a project with only two single API endpoints. For a project with a larger amount of endpoints or more complex endpoints, this functionality would be a very good choice, however. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
The current open api document is hard-code in the projects, We should have some manner to generate the documentation based on the code itself.
Once we change the code, we will get the open api document at time.
Once we can see the full document we will find out what the schema model we have in the interfaces layer and how many endpoint we have exposed , etc.
So it can help use to know the interfaces layer implementation in a visual way and easy to debug.
It also can help the user(who want to learn from this project) to get the api description.
What