documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[Bug]: No swagger or openapi.json

Open brianegan opened this issue 2 years ago • 1 comments

Link to the documentation page or resource

https://docs.strapi.io/developer-docs/latest/plugins/documentation.html#swagger-json-and-openapi-json-files

Describe the bug

This documentation appears to be stale. I was testing Strapi for a new project because I read the documentation claiming that Strapi produces a swagger.json file. Sadly, after configuring some collections, it seems the documentation is wrong.

Strapi does not appear to expose a swagger.json or openapi.json. The PR to enable this functionality was recently closed: https://github.com/strapi/strapi/pull/8486

There is also an open issue on the main repository which has not been addressed for several months: https://github.com/strapi/strapi/issues/10734

Additional context

No response

Suggested improvements or fixes

Remove the documentation or better yet implement the feature!

Related issue(s)/PR(s)

https://github.com/strapi/strapi/pull/8486 https://github.com/strapi/strapi/issues/10734

brianegan avatar Dec 12 '21 11:12 brianegan

For me this is a necessary feature to even start with Strapi. Its pending for a long time and the documentationis very misleading. Was trying to get the documentation for an hour until I found this issue here.

garcipat avatar Jul 16 '22 18:07 garcipat

Still relevant

thawankeane avatar Feb 17 '23 03:02 thawankeane

stiil an issue for latest version 4.9.1

wujun4code avatar Apr 16 '23 03:04 wujun4code

Hi @brianegan and apologies it took so long to provide an answer.

Does the issue still persists with Strapi v14? If yes I'll transfer this to our engineers, as this is more of a product issue (e.g., something to be fixed in the strapi/strapi repo first).

pwizla avatar Oct 25 '23 09:10 pwizla

Closing the issue for now and assuming it works for Strapi v14. Feel free to re-open if you have additional information to provide.

pwizla avatar Nov 06 '23 15:11 pwizla