[Documentation] Auto-generated Spring REST doc

futurewei-cloud / alcor

Alcor: Cloud native SDN platform powered by Kubernetes and Istio

MIT License

32 stars 33 forks source link

[Documentation] Auto-generated Spring REST doc #150

Open xieus opened 4 years ago

xieus commented 4 years ago

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 commented 4 years ago

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

skdong commented 4 years ago

OK, I will do my best

xieus commented 4 years ago

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

xieus commented 3 years ago

@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.