Skip to content
This repository was archived by the owner on Mar 31, 2023. It is now read-only.

Conversation

@skdong
Copy link
Contributor

@skdong skdong commented Apr 28, 2020

[document] Apis - auto genrate Rest API docs (#150 )

  • Add api-gateway, mac-manager,subnet-manager RestDocs documents, including the request and response content in unit testing, according to the unit test sub-direcotry placed under the adocs direcotry under each microservice

  • Add mac-manager,privateip-manager,subnet-manager,vpc-manager Swagger Documents, Swagger Documents include html and pdf two formats ,placed in the swagger dircotry of ech microservice

@@ -0,0 +1,4 @@
[source,bash]
Copy link
Contributor

Choose a reason for hiding this comment

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

This is definitely a huge PR with 126 files change :-) How do we get those files generated?

Is it possible that we only check in the codes that could trigger docs auto generation on the compile time, for example, when we do "mvn test & mvn install"

@xieus xieus added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 28, 2020
@skdong skdong mentioned this pull request Apr 28, 2020
@xieus xieus linked an issue Apr 28, 2020 that may be closed by this pull request
@skdong skdong closed this May 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Auto-generated Spring REST doc

2 participants