Swagger Specifications for CH API

Hi Team,

I am working on an integration with the available Companies house API. We are currently handcrafting the API definition as there are no SWAGGER/YAML definitions available to download.

Is there a plan to upload SWAGGER 2.0 definition for the API’s in the next coming months? Is there any alternate way to define definition at the consumer end at the moment?

Hi there.

Yes, we will be releasing Swagger 2.0 JSON specifications that you can download and use with swagger-core or other tooling of your choice to build your clients.

We are rebuilding our Developer Hub documentation to use DapperDox (a documentation presentation tool we recently open sourced) and are rewriting our specifications as Swagger 2.0. We plan on releasing this over the next month or so - but this is a background task as we have higher priority work to be completed too!

Hope that will help?

thanks and good to know this is in the bucket list as without Swagger life does get a bit tedious :smile:

Any updates no the Swagger 2 spec being published? We’re half a year on from your “next month or so” and I don’t see it anywhere obvious!

1 Like