Restii #177
Restii #177
Conversation
| .andDo(print()) | ||
| .andExpect(status().isOk()); | ||
| .andExpect(status().isOk()) | ||
| .andDo(document("start")); |
There was a problem hiding this comment.
should we use "mac_range_post"?
There was a problem hiding this comment.
- This corresponds to the directory name of the generated document. I think the name and the request are the same for easy search. I can change it if necessary, but it cannot conflict with other requests, otherwise it will overwrite the file
| @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, | ||
| properties = {"httpbin=http://localhost:${wiremock.server.port}"}) | ||
| @AutoConfigureWireMock(port = 0) | ||
| @AutoConfigureRestDocs(outputDir = "target/generated-snippets") |
There was a problem hiding this comment.
If most of the 126 files on the other PR could be found in the target/generated-snippets directory, that would be great. This means that we could safely remove those files in the /docs/apis/ directory as we could always find the latest by running "mvn test". right?
There was a problem hiding this comment.
Quick question: are we able to find the html files like alcor/docs/apis/mac-manager/swagger/html/index.html in the target/generated-snippets directory?
There was a problem hiding this comment.
-
Yes, we can generate those files under the target / generated-snippets directory by executing mvn test
-
The code for the swagger part has not been submitted. Currently, Swagger documentation can be viewed by visiting the /swagger-ui.html path after the microservice is started. Before, I used a separate html generated by a third-party tool. I tried to generate html automatically when I tried mvn test.
There was a problem hiding this comment.
Cool! How can we access the /swagger-ui.html if the microservice is not started?
There was a problem hiding this comment.
I found some ways to generate swagger html files during mvn test, I am now verifying
| <version>0.1.0-SNAPSHOT</version> | ||
| <scope>compile</scope> | ||
| </dependency> | ||
| <dependency> |
There was a problem hiding this comment.
We just merged new UTs to VPC and Route Controllers. Could you please add the docs accordingly. Thank you.
There was a problem hiding this comment.
Ok let me add it
Now there is a problem, most microservices mvn test need to connect to the database, I currently deploy the database can be executed, but it is best to be able to leave the database
There was a problem hiding this comment.
Is it possible to have a flag which could switch off DB access when generating the docs?
There was a problem hiding this comment.
The document is generated after the unit test is completed. As long as the unit test does not depend on the database during execution, the document can be generated.
There was a problem hiding this comment.
I see. Please work with @chenpiaoping to see if we can support DB-related UTs by Ignite mock.
3 participants
[document] Apis - auto genrate Rest API docs (#150)(#176)
Add api-gateway, mac-manager,subnet-manager,privateip-manger Spring REST Docs generated code