Swagger/OpenAPI for api?

CristianCson wrote 7 years ago: 1

Hi, looks like a nice service you have here.

I noticed you got Swagger for the user API but can't find one for the regular api, is there one available?

It goes so much faster to use the api when a swagger/OpenAPI is in place.. Especially for trying out...


Jan wrote 7 years ago: 1

Hi Cristian,

Your assessment is correct. We only use Swagger for the user API.
Have you gone through the documentation on the TVmaze API page? Anything that you found unclear?

CristianCson wrote 7 years ago: 1

Jan wrote:
Hi Cristian,

Your assessment is correct. We only use Swagger for the user API.
Have you gone through the documentation on the TVmaze API page? Anything that you found unclear?

I just browsed through it, it looks quite straightforward, but the goal is to generate the necessary classes by a standard tooling like Autorest, it saves a lot of time so I was a little happy when I saw that you had it but disappointed when it only was on the user api...

I think the OpenAPI spec is a really good way forward for API's so hope you will add it to the standard API in the future as well..


david wrote 7 years ago: 1

Maintaining the definition for the public API would be a lot more work, which is why we don't do it so far. But we'll keep your wish in mind :)

CristianCson wrote 7 years ago: 1

Yes it will be more work but will be easier for the developers using the api, and also save time with the documentation..

But it is work of course, I understand, good that you keep it in mind :)

Try 30 days of free premium.