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

[type:refactor]Decouple apidoc module from rule and selector modules #5685

Open
wants to merge 80 commits into
base: master
Choose a base branch
from

Conversation

478320
Copy link
Contributor

@478320 478320 commented Sep 29, 2024

decouple apidoc module from rule and selector modules, link #5623

Make sure that:

  • You have read the contribution guidelines.
  • You submit test cases (unit or integration tests) that back your changes.
  • Your local test passed ./mvnw clean install -Dmaven.javadoc.skip=true.

@478320 478320 force-pushed the feat_decouple_api_rule_select branch from 0f4a8fd to 7f98cd7 Compare October 1, 2024 04:09
@@ -110,6 +109,7 @@ public String createOrUpdate(final ApiDTO apiDTO) {
* @return update message
*/
private String update(final ApiDTO apiDTO) {
//cdbuild apiDO
Copy link
Member

Choose a reason for hiding this comment

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

why add this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello, my previous submission failed to check the instability of ci. I hope I can re-trigger ci through some modifications. If these modifications cause bad effects, I will delete them

@@ -126,11 +126,6 @@ private String update(final ApiDTO apiDTO) {
tagRelationMapper.deleteByApiId(apiDO.getId());
tagRelationMapper.batchInsert(tags);
}
if (ApiStateEnum.PUBLISHED.getState() == apiDO.getState()) {
Copy link
Member

Choose a reason for hiding this comment

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

why remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When creating apidoc, this part determines whether the document is in the published state, and if the document is in the published state, the selector is registered, etc. If it is in the offline state, the corresponding selector content is deleted, which will lead to the coupling of apidoc and selector. Deleting this part can release their coupling. The removal of this feature will have the following effects, the document publication and logout will only be displayed as a status without additional functions, the document logout and online need to manually add and delete selectors and other content, for the creation of api documents, Users using @RequestMapping and other annotations and users using swagger will automatically create selectors and other content through annotations, which will not affect the convenience brought by automation. To add api documents in the visual interface, you need to manually create corresponding selector, rule, and Metadata. For the offline api document, all users need to manually delete the corresponding selector, rule, and Metadata

@moremind moremind added this to the 2.7.0 milestone Nov 27, 2024
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.

6 participants