feat(api-doc): support request parameter parsing for RPC types (Dubbo/SOFA/TARS/gRPC)#6339
Open
eye-gu wants to merge 4 commits into
Open
feat(api-doc): support request parameter parsing for RPC types (Dubbo/SOFA/TARS/gRPC)#6339eye-gu wants to merge 4 commits into
eye-gu wants to merge 4 commits into
Conversation
This file contains hidden or 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
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.
close #6338
Previously, API document generation only supported Spring Web annotation-based parameter parsing (
@RequestParam,@RequestPart, path variables), which only works for HTTP/WebSocket/Spring Cloud. RPC types (Dubbo, SOFA, TARS, gRPC) had no request parameter information in generated documents.Changes
OpenApiUtils - RPC-aware document generation
buildDocumentJson()that dispatches by RPC type:StreamObservermethod patternrequestParameters/responseParametersSOFA - enable API document support
SofaServiceEventListenerto extendAbstractContextRefreshedEventListenercommon flowhandler()/onApplicationEvent()with standardgetCorrectedClass()+buildApiPath()hooksExamples
@ApiModule/@ApiDocannotations to Dubbo protobuf example servicesImpact
Make sure that:
./mvnw clean install -Dmaven.javadoc.skip=true.