docs: add swagger graphical interface for documentation #37

New issue

Closed

opened 2024-11-29 16:27:27 +00:00 by sunkanmii · 3 comments

sunkanmii commented

2024-11-29 16:27:27 +00:00

(Migrated from github.com)

Hey!

So I noticed the documentation just points to the yaml file and not a visual graphical representation of that yaml file.

I searched the net and found this. Honestly, I don't understand your full code yet, so I can't place anything in it. I'm wondering if you could take a look into this simple stackoverflow solution and see if you could add it to the routes and html views maybe.

Link https://stackoverflow.com/questions/69042448/how-to-generate-openapi-docs-swagger-ui-page-using-static-yaml-file-with-flas

Hey! So I noticed the documentation just points to the yaml file and not a visual graphical representation of that yaml file. I searched the net and found this. Honestly, I don't understand your full code yet, so I can't place anything in it. I'm wondering if you could take a look into this simple stackoverflow solution and see if you could add it to the routes and html views maybe. Link https://stackoverflow.com/questions/69042448/how-to-generate-openapi-docs-swagger-ui-page-using-static-yaml-file-with-flas

Valbou commented

2024-11-30 07:06:34 +00:00

(Migrated from github.com)

Hello,

OpenAPI v3 is a format you can freely use with Swagger and Postman. There is no need to deploy a graphical representation today with new third party dependencies.

Hello, OpenAPI v3 is a format you can freely use with Swagger and Postman. There is no need to deploy a graphical representation today with new third party dependencies.

sunkanmii commented

2024-12-03 12:52:25 +00:00

(Migrated from github.com)

Hmmmm.

I see your point. If I request the API documentation of any software, I don't want to go directly to the YAML or JSON file; it's too raw in that format and not developer-friendly. But if I see a user interface that I can easily understand and grasp at a glance, I will opt for that instead.

I tried looking for some examples I saw here, but I've browsed a lot of repositories and somehow I lost them. It's cool though.

Feel free to close this issue then.

Hmmmm. I see your point. If I request the API documentation of any software, I don't want to go directly to the YAML or JSON file; it's too raw in that format and not developer-friendly. But if I see a user interface that I can easily understand and grasp at a glance, I will opt for that instead. I tried looking for some examples I saw here, but I've browsed a lot of repositories and somehow I lost them. It's cool though. Feel free to close this issue then.

Valbou commented

2024-12-04 12:19:38 +00:00

(Migrated from github.com)

I understand, but the API is needed only to make a frontend.
And currently it's not a priority to have a third party integration.

A frontend is already under active development in another git repo : https://github.com/Valbou/vtaskr-frontend
And there is many usage examples. But not ready for production at this stage.

I understand, but the API is needed only to make a frontend. And currently it's not a priority to have a third party integration. A frontend is already under active development in another git repo : https://github.com/Valbou/vtaskr-frontend And there is many usage examples. But not ready for production at this stage.