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

Triple Rest Openapi Support #14924

Open
wants to merge 12 commits into
base: 3.3
Choose a base branch
from
Open

Triple Rest Openapi Support #14924

wants to merge 12 commits into from

Conversation

oxsean
Copy link
Collaborator

@oxsean oxsean commented Nov 22, 2024

What is the purpose of the change?

Add OpenAPI support for Triple REST protocol, enabling automatic OpenAPI documentation generation
for dubbo services. The implementation includes:

  • Dynamic OpenAPI spec generation from service metadata
  • Support for JSON/YAML formats
  • Configurable schema naming strategy
  • Document caching and merging
  • Group/Version/Tag filtering
  • Customizable documentation through annotations

How to testing

Automatically generates OpenAPI documentation for all Dubbo services with zero configuration:

  1. Access Swagger UI:

    http://host:port/dubbo/openapi
    
  2. Access OpenAPI Spec:

    http://host:port/dubbo/openapi/api-docs
    
  3. Supported formats:

    • JSON (default): /dubbo/openapi/api-docs
    • YAML: /dubbo/openapi/api-docs.yaml
  4. Optional filters:

    • Group: /dubbo/openapi/api-docs/{group}
    • Version: /dubbo/openapi/api-docs?version=1.0.0
    • Tags: /dubbo/openapi/api-docs?tag=user,order

Example

Start dubbo-demo/dubbo-demo-spring-boot/dubbo-demo-spring-boot-servlet
then access:

http://localhost:8082/dubbo/openapi

Show case

image
image
image

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

Successfully merging this pull request may close these issues.

1 participant