Feature Request: Provide Swagger / OpenAPI Specification

[j10ccc]

Hi @svrooij,

First of all, thanks for this great documentation project!

I was wondering if there are any plans to provide a Swagger (OpenAPI) specification file (e.g., swagger.json or openapi.yaml)?

Having an OpenAPI spec would be extremely beneficial for:

• Automatically generating API clients for various programming languages.
• Exploring the API interactively using tools like Swagger UI or Postman.
• Better integration with other tools in the API ecosystem.

Is this something you would consider adding?

Thanks!

[svrooij]

I would absolutely love to do that, but it won't help because OpenAPI specs are not for describing soap endpoints. So it would not be possible to have swagger send the correct requests, and then there is cors which will prevent calling Sonos from any browser source.

There is however a project of mine that runs a true rest api in a docker container that has all these endpoints and an OpenAPI specs file and a testing tool like swagger which is called scalar (which looks better in my opinion). This is all generated based on the docs above.

I even started a blazor (c# web assembly) front-end but that is more of a work in progress.

Check it out at https://github.com/svrooij/sonos-net/tree/feature/net8