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

OpenApi json file support #31

Open
mehdihadeli opened this issue Jun 30, 2023 · 4 comments
Open

OpenApi json file support #31

mehdihadeli opened this issue Jun 30, 2023 · 4 comments
Labels
feature New feature or request

Comments

@mehdihadeli
Copy link

mehdihadeli commented Jun 30, 2023

Hi,
Thanks for this useful apis.
Is it possible to add openapi like swagger to this app? For example, a swagger.json file.
We could use this swagger.json file for generating different clients

@SrGeneroso
Copy link

Yep, I was looking for that. Bump this.

@c4rth
Copy link

c4rth commented Oct 31, 2023

Hi,
I made an experiment with swagger-jsdoc and swagger-ui-express.
Fork available here

I only did it for the products API (and without descriptions, examples, ...)

The Open API json file is available at '/api-docs/swagger.json' and the Swagger UI at '/api-docs'.

This could be a solution, surely not the only one.
Embed Swagger UI is not necessary if you only want the json file, but it could replace a large part of the docs files.

Best Regards

json file
swagger.json

screenshots
swagger-products
swagger-products-get

@Ovi
Copy link
Owner

Ovi commented Nov 1, 2023

Thank you @c4rth for this, I (or someone else) can use this as a starting point to implement this feature, I'm trying to make up some time to start working on this.

@safdevke
Copy link

safdevke commented Apr 3, 2024

Hi, would you consider adding a 'feature/openapi' branch for this feature? I have added docs for carts and partially updated docs for users, building upon @c4rth products' example.

image

@Ovi Ovi added the feature New feature or request label Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants