Page 1 of 1

Swagger doc

Posted: Sat Apr 28, 2018 11:10 am
by fburke
Hi I've updated to the 4.1.2 firmware and was looking for see how I can program it. There is a swagger doc link to the RESTful API for the BCS but there does not appear to be any doc there. Can anyone else see the doc? All I see is "fetching resource list: http://www.embeddedcc.com/api-docs/api-docs.json" and nothing happens. Can someone help me actually get the API doc? Thanks.

Re: Swagger doc

Posted: Sat Apr 28, 2018 11:15 am
by JonW
Check here: http://embeddedcc.github.io/api-docs/

Create a hostname of "bcs" in your computers "hosts" file set to your bcs unit ip address and you can use the API interactively.

Re: Swagger doc

Posted: Sat Apr 28, 2018 2:50 pm
by fburke
Thanks Jon. That’s what I needed.

Re: Swagger doc

Posted: Sat Apr 28, 2018 3:35 pm
by JonW
Always curious to see what people do with the API. What are you working on?

Re: Swagger doc

Posted: Sun Apr 29, 2018 6:00 am
by fburke
I’ve not started anything yet but I wanted to check out what the API looked like. I’ve been a software engineer for 38 years and I’m thinking about a project to work on in retirement.

For folks w/o a engineering background I’d bet the current interface is very daunting. So I’d like to create an open source app that is more plug-n-play so other brewers can ‘just brew’ with it but if they wanted to get into the details they could.

That’s the current thought at least.