Tool that supports automatically generating API documentation #5609
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.
Introduction
A tool that automatically generates API documentation for kubeedge.
Implementation Method
Generate OpenAPI definitions using openapi-gen: The
openapi-gen
tool generates Go template code containing OpenAPI definitions from comment information. By adding a specific annotation+k8s:openapigen=true
in thedoc.go
file,openapi-gen
will scan all types in the package to generate OpenAPI definitions, which are stored in thezz_generated.openapi.go
file.Generate OpenAPI Specification:
Write
generateswagger.go
referencing the generated OpenAPI definitions (zz_generated.openapi.go
) to create the OpenAPI specification (swagger.json
). Theswagger.json
file contains all the OpenAPI definition information of the apiserver.Contents of
generateswagger.go
include: