BookStackApp / BookStack

A platform to create documentation/wiki content built with PHP & Laravel
https://www.bookstackapp.com/
MIT License
14.83k stars 1.86k forks source link

Please support or provide swagger open api spec file. #4816

Closed ilbw97 closed 7 months ago

ilbw97 commented 7 months ago

Describe the feature you'd like

I own my website using bookstack, and i also using waap service. I want to use api protection that i use, but they require open api spec file to protect my website's api traffic. i know you guys already provide /api/docs.json and /api/docs but it's very hard to find openapi spec file like yaml or json format.

Describe the benefits this would bring to existing BookStack users

all users that trying to protect api traffic of their website could operate their website more convenience.

Can the goal of this request already be achieved via other means?

no

Have you searched for an existing open/closed issue?

How long have you been using BookStack?

1 to 5 years

Additional context

No response

ssddanbrown commented 7 months ago

Thanks for the request @ilbw97. Personally, I don't feel like supporting a whole specific spec will be worthwhile for the benefit of what would likely be a very minor part of our audience's usage for certain features in external software/platforms.

I did build a script to (roughly) create postman collections from the API data, you might be able to do something similar (Or import postman and export to openapi) but this kind of thing won't cover app (non-api) routes and may not cover the flexibility & options that is afforded in our API.

ilbw97 commented 7 months ago

Thank you for answering my request. Finally, I got it :)!

ssddanbrown commented 7 months ago

No worries, I'll therefore close this off as out of scope.