Swagger/OpenApi Definition Generator Plugin

[javierlinked]

Hi Payload team and community,

First of all, thank you for the incredible work you’ve been doing with PayloadCMS. It’s been an essential part of my current projects, and I appreciate the continued improvements.

I’d like to propose a feature request for a plugin that generates Swagger (OpenAPI) definitions for Payload collections custom endpoints routes. There was an existing package, payload-tools, that provided this functionality. However, since it's no longer maintained, and with the recent changes to Next.js routing, it’s not just a matter of upgrading the references.

The idea is to build a plugin similar to payload-tools that can handle the updated routing system in Next.js and Payload 3.0. Ideally, this plugin would:

• Generate Swagger documentation for REST endpoint.
• Add some extensibility for documentation (examples, descriptions for parameters etc).
• This feature would be a huge help for Payload developers/implementers since this facilitates enormously other subsystems to interact with the CMS.

I’d love to hear your thoughts on this.

Thank you!

https://github.com/scalar/scalar/tree/main/packages/nextjs-openapi this could also be a good starting point.