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

Dubbo Rest protocol interface cannot generate interface document #983

Open
3 tasks done
wuking26 opened this issue Dec 6, 2024 · 4 comments
Open
3 tasks done

Dubbo Rest protocol interface cannot generate interface document #983

wuking26 opened this issue Dec 6, 2024 · 4 comments

Comments

@wuking26
Copy link

wuking26 commented Dec 6, 2024

Contact Details

No response

Version

3.0.4

Plugin

smart-doc-maven-plugin

Build tool version

3.8.4

Jdk version

1.8

Describe the bug (Bug描述,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

Previously, we had Dubbo interfaces, and after adding new Dubbo REST interfaces, we are unable to generate the corresponding REST interface documentation.

以前的dubbo接口,新增dubbo rest接口后无法生成对应的rest接口文档
WX20241206-154613@2x

Expected Behavior (您期望的结果,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

Please confirm whether support is available for generating Dubbo REST interface documentation.

期望告知是否支持生成dubbo rest接口文档

Current Behavior (当前结果,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

Steps to Reproduce (Bug产生步骤,请尽量提供用例代码。社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

Uploading WX20241206-154613@2x.png…

Possible Solution (Bug解决建议,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Context (Bug影响描述,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Validations

  • Check if you're on the latest smart-doc version. (请检查是否为最新版本)
  • Read the docs. (请先阅读官方文档)
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. (检查是否存在报告相同错误的问题,以避免产生重复)
@wuking26
Copy link
Author

wuking26 commented Dec 6, 2024

After adding a Dubbo REST interface, the corresponding REST interface documentation fails to be generated. The expectation is to generate corresponding Dubbo interface documentation as well as corresponding REST interface documentation. As shown in the figure
WX20241206-154613@2x

@linwumingshi
Copy link
Collaborator

@wuking26 Please translate the issue title and content into English.

And
Pull requests are warmly welcomed for collaborative development.

@shalousun
Copy link
Collaborator

shalousun commented Dec 9, 2024

@wuking26 Please translate the issue-related information into English. Additionally, Dubbo REST is implemented using the JAX-RS protocol, so you can configure "framework": "JAX-RS" to support the generation of Dubbo REST API documentation.

@linwumingshi linwumingshi changed the title dubbo rest协议接口不能生成接口文档 Dubbo Rest protocol interface cannot generate interface document Dec 14, 2024
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

No branches or pull requests

3 participants