OpenAPI endpoint and SwaggerUI or Redoc or other clients

[alessandromarchetti]

Hi, I have 2 questions about medusa server and I couldn't find the information in the docs:

• Is there one or more endpoints exposing auto-generated OpenAPI specs for the APIs (both store and admin and, possibly, custom endpoints added via customization)?
• If the answer is yes, is there a SwaggerUI or a Redoc endpoint (or any other web client) which renders the documentation?

Thanks in advance for anyone who could help
Alessandro

[srindom]

Hi @alessandromarchetti! We don't have an endpoint on the server that exposes this, but @patrick-medusajs has recently built a powerful OpenAPI Spec generator which will be released in v1.8. You can check out the release candidate for more details: https://github.com/medusajs/medusa/releases/tag/v1.8.0-rc.0

[alessandromarchetti]

Thank you!

[alessandromarchetti]

Does the OpenAPI Spec generator also include custom endpoints, whether they are added or overridden via standard medusa plugins or by using medusa-extender?

[patrick-medusajs]

Yes it will. By passing the directory path to codebase containing the custom endpoints, the OAS generator will crawl and discover swagger-inline OAS comments. Any paths or schemas discovered will be combined into Medusa's default OAS. The package's readme can help you get you started with the new medusa-oas CLI.