Swagger doc

Describe your system and processes, and post your config file.
Post Reply
fburke
Posts: 4
Joined: Mon Nov 14, 2016 4:19 pm
Bot?: No

Swagger doc

Post 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.
JonW
Site Admin
Posts: 1726
Joined: Sun Jul 18, 2010 7:51 am
Bot?: No
Location: Huntington Beach, CA
Contact:

Re: Swagger doc

Post 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.
fburke
Posts: 4
Joined: Mon Nov 14, 2016 4:19 pm
Bot?: No

Re: Swagger doc

Post by fburke »

Thanks Jon. That’s what I needed.
JonW
Site Admin
Posts: 1726
Joined: Sun Jul 18, 2010 7:51 am
Bot?: No
Location: Huntington Beach, CA
Contact:

Re: Swagger doc

Post by JonW »

Always curious to see what people do with the API. What are you working on?
fburke
Posts: 4
Joined: Mon Nov 14, 2016 4:19 pm
Bot?: No

Re: Swagger doc

Post 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.
Post Reply