search

CGUC / skybunk-server

The back-end application for Conrad Grebel University College students to stay connected
3 stars 9 forks source link

Document API #90

Open scholvat opened 5 years ago

ahiijny commented 4 years ago

I guess the two main options are to either (1) document the API inline with the code using annotation syntax and then use something like ApiDoc to automatically generate the API documentation files, or (2) maintain the API spec in a parallel OpenAPI yaml file and generate the API documentation files from that.

scholvat commented 4 years ago

Option 1 would be ideal to make sure it stays up to date.

On Sat, Dec 7, 2019 at 10:02 AM ahiijny notifications@github.com wrote:

I guess the two main options are to either (1) document the API inline with the code using annotation syntax and then use something like ApiDoc to automatically generate the API documentation files, or (2) maintain the API spec in a parallel OpenAPI yaml file and generate the API documentation files from that.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/CGUC/skybunk-server/issues/90?email_source=notifications&email_token=ACNK45VLOZ4BEVZBH7KU5Y3QXPQK7A5CNFSM4HL4YHG2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGGMEZQ#issuecomment-562872934, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACNK45ULUSOA2XSSO3LZ4MLQXPQK7ANCNFSM4HL4YHGQ .