Automated doc generation

[PhilipWee]

Describe the bug

Not really a bug, but I don't think it should be a necessity to specify the request url and request method (And perhaps even the possible responses) because all these are things that are available within the code itself

For example we can look at the folder path and exported module name and from there derive the available methods and api paths

Reproduction

/** * @Swagger * /api/hello: * get: * description: Returns the hello world * responses: * 200: * description: Hello World! */

System Info

/**
 * @swagger
 * /api/hello:
 *   get:
 *     description: Returns the hello world
 *     responses:
 *       200:
 *         description: Hello World!
 */

Used Package Manager

yarn

Validations

• Follow our Code of Conduct
• Read the Contributing Guide.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
• The provided reproduction is a minimal reproducible of the bug.

[PhilipWee]

Let me know if you want me to make a PR for this, I don't mind (Since it will make the final code more DRY)

[jellydn]

Thanks @PhilipWee

Let me know if you want me to make a PR for this

That sounds great. Please open the PR.

[SaadBazaz]

Combining Zod, JSDoc, and some preprocessing scripts can help us autogenerate the OpenAPI spec.

[mildfuzz]

Combining Zod, JSDoc, and some preprocessing scripts can help us autogenerate the OpenAPI spec.

hey, any chance you could provide a process for achieving this? this is what I a researching currenty

[jellydn]

Combining Zod, JSDoc, and some preprocessing scripts can help us autogenerate the OpenAPI spec.

hey, any chance you could provide a process for achieving this? this is what I a researching currently

I would do the PoC about this sometime. However, you could combine those tools to work nicely together

• https://zod.dev/
• https://github.com/asteasolutions/zod-to-openapi
• https://github.com/Surnet/swagger-jsdoc/blob/v6/docs/README.md

[Coean]

Just want to know why the PR: #812 hasn't been approve for so long? The feature he does is what I want.

[tgdn]

Are there any updates on this issue? Thanks!

[jellydn]

Just want to know why the PR: #812 hasn't been approve for so long? The feature he does is what I want.

As far as I know, it's WIP (not ready yet). PRs always welcome anyway :)