Swagger api doc

Open Bycob opened this issue 1 year ago • 2 comments

Swagger documentation is served by the DeepDetect server at host:port/swagger/ui

Open API json is also served by the server at host:port/api-docs/oas-3.0.0.json. It can be used to serve documentation as a separate page, for example with Fast API.

To serve the documentation as a static page, the required files are:

/api-docs/oas-3.0.0.json
/swagger/favicon-16x16.png
/swagger/ui
/swagger/swagger-ui.css
/swagger/swagger-ui-bundle.js
/swagger/swagger-ui-standalone-preset.js

Jun 05 '24 16:06 Bycob

Can you add something to the README ?

Jun 28 '24 10:06 beniz

Can you add something to the README ?

Added a line about auto generated doc

In the future, the link to API Reference should be changed to the auto-generated documentation

Jun 28 '24 13:06 Bycob