Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger api doc #1563

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Swagger api doc #1563

wants to merge 1 commit into from

Conversation

Bycob
Copy link
Collaborator

@Bycob Bycob commented Jun 5, 2024

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

@beniz
Copy link
Collaborator

beniz commented Jun 28, 2024

Can you add something to the README ?

...so that old documentation is no longer required
@Bycob
Copy link
Collaborator Author

Bycob commented Jun 28, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants