Swagger and OpenAPI plugins

[teunmooij]

Hi, we've just released the first major version of our payload-swagger and payload-openapi plugins.

With payload-openapi you can generate openAPI 3.0 documentation for your payload instance, which includes:

• collection endpoints
• global endpoints
• custom endpoints
• authentication endpoints
• preferences endpoints
• fully typed schema definitions for all requests, parameters and responses
• authentication requirements for all your endpoints
• extension points to merge your custom openapi definitions into the schema

The payload-swagger plugin turns payload-openapi into a simple plugin that not only generates the openAPI document, but also adds a swagger UI endpoint to your payload server.

You can find them here:

• payload-swagger: https://www.npmjs.com/package/payload-swagger
• payload-openapi: https://www.npmjs.com/package/payload-openapi
• sources: https://github.com/teunmooij/payload-tools

[RafaelPaulo12]

Hi.
Is there any prediction for an update of the payload-swagger and payload-openapu plugins for Payload version 3 ?

[janbuchar]

Hi, I'm working on payload 3.0 support for my openapi plugin - janbuchar/payload-oapi#18. Feel free to check it out 🙂

[jeanlescure]

@janbuchar you are the real MVP

I had recently mentioned this as one of my team's pain points with PayloadCMS:

#11213 (comment)

I just tried your plugin, it almost works perfectly, in our case even when developing locally we use a dummy domain with https which caused a CORS/MIME issues with unpkg, I opened a Pull Request with the fix:

janbuchar/payload-oapi#24

Thank you and keep up the awesome work! 🚀

[janbuchar]

Hi @jeanlescure ! It's great to hear that you find that plugin useful, I'm super happy for that 🙂

[vipuljbhikadiya]

@janbuchar plugins is awesome. does this support auth paths in any collection? or is that in roadmap ?

[janbuchar]

@vipuljbhikadiya I'm not sure I follow, can you show me an example config? Or feel free to open an issue in the payload-oapi repo.