Packages API Documentation
- First try with apidoc based on JSDoc (see setup-apidoc branch) and generate associated PDF file with Playwright
- Second try, thanks to Playwright convert https://petstore.swagger.io/ to PDF file, result to really readable api-doc.pdf
- Last idea use Swagger and make the inline swagger doc available through Gitlab. Try with 57d1e064 the documentation is available in Settings > Pages and url http://publicgroup.pages.linagora.com/oss/twake/tom-server Moreover Gitlab understand OpenApi, therefore if we go to documentation/openapi.yaml the file is displayed like in a swagger page Finally I used swagger-ui-dist library to display API doc in Gitlab pages (cf https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md and https://gitlab.com/mdhtr/gitlab-pages-swagger-ui)
Edited by Jordy CABANNES