alcor icon indicating copy to clipboard operation
alcor copied to clipboard

[Documentation] Auto-generated Spring REST doc

Open xieus opened this issue 5 years ago • 4 comments

Basic Requirement

  • Use an automatic way to generate REST API document for API gateway and others microservices listed in this directory: https://github.com/futurewei-cloud/alcor/tree/master/services

Resource https://github.com/asciidoctor/asciidoctor-intellij-plugin/wiki/Spring-REST-Docs-support

xieus avatar Apr 07 '20 21:04 xieus

@skdong, would you like to take the lead on this item?

xieus avatar Apr 20 '20 04:04 xieus

OK, I will do my best

skdong avatar Apr 20 '20 05:04 skdong

Thank you for the contribution. The task has been assigned.

xieus avatar Apr 20 '20 05:04 xieus

@DavidLiu506 This is a bit old issue which we planned to enable automatic REST documents for our APIs. It has been half done by PR #177 but we didn't test it.

Could you put this item in your backlog and pick it up when current high-pri items have been completed? Thanks.

xieus avatar Jul 02 '21 16:07 xieus