-
Notifications
You must be signed in to change notification settings - Fork 34
Automatically generate Swagger documentation #184
Conversation
2. Export Swagger json document through unit test, document directory /target/swagger/swagger.json 3. Convert Swagger json document to adoc document, document directory target / swagger / swagger.adoc
@xieus yes We only need to run "mvn test" to create swagger adoc |
@xieus This PR generates a Swagger adoc. Swagger generates documents through Spring Controller. PR # 177 generates adoc for each unit test. There is no corresponding Spring Controller for apigateway type api. It needs to be generated for unit test |
@skdong Thanks for the response. I just tried to run "mvn test" in the swagger-auto branch, I didn't find the target/swagger sub-directory showed up. Something I might have missed? |
@xieus This is because I turned off the unit test, the operation of generating the document was completed in a unit test, and now the unit test still depends on the database. |
@xieus I can open the unit test and submit it, but It need to have a connectable database. |
The Ignite UT issue is kind of headache. We will have to live without Ignite UTs until the issue is fixed. @chenpiaoping could you please take a look? This is becoming a blocking issue for us. |
@xieus Ok I will unblock it |
@xieus I only activated Uts of route, subnet, vpc, these microservices are normal now. Mac and private IP UTs still have errors when executed mac microservice tips com.futurewei.alcor.common.db.CacheFacotry confilicts with com.futurewei.alcor.common.service.CacheFacotry Private ip microservice prompt Unable to connect to localhost: 6379 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
@skdong I think the current PR looks good, and the Mac Manager and IP Manager UTs error could be fixed by service owner. @kimeunju108 please look into the Mac Manager UTs, and @chenpiaoping please look into the IP manager UTs. |
[document] Swagger Rest API adoc (#150)(#176)