Tool that supports automatically generating API documentation for KubeEdge

[greensong]

1. Generate OpenAPI Definitions with openapi-gen:
Use the openapi-gen tool to generate Go template code containing OpenAPI definitions based on annotation information. By adding a specific annotation +k8s:openapigen=true in the doc.go file, openapi-gen scans all types under that package and generates OpenAPI definitions for them, stored in the zz_generated.openapi.go file.

2. Generate OpenAPI Specification:
Write generateswagger.go to reference the generated OpenAPI definitions (zz_generated.openapi.go) and generate the OpenAPI specification (swagger.json). The swagger.json file contains all the OpenAPI definition information for the API server.

The contents of generateswagger.go are as follows:

• Create Schema objects for type registration and object instantiation.
• Create a REST Mapper Mapper for conversion between GVR (GroupVersionResource) and GVK (GroupVersionKind).
• Add specific mappings for various KubeEdge resources.
• Set information for the OpenAPI specification.

The specific process is as follows:

• Run “go run auto_generate_openapi.go” to call the openapi-gen tool and generate OpenAPI definitions.
• After generating the OpenAPI definitions, run “go run generateswagger.go” to create the OpenAPI specification.

[kubeedge-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign fisherxu after the PR has been reviewed.
You can assign the PR to them by writing /assign @fisherxu in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[WillardHu]

Thank you for your contribution, you need to pass the DCO check first.
Refer https://github.com/kubeedge/kubeedge/pull/5582/checks?check_run_id=24349847302

[WillardHu]

These source codes of a openapi generation tool that does not fit in the hack/ directory, is there a better choice?

[WillardHu]

I think a shell script would be more appropriate then the gofile for execute openapi-gen command. BTW, we can use the compiled binary openapi-gen.