search

Bounz / HomeGenie-BE

HomeGenie (Bounz Edition)
GNU General Public License v3.0
5 stars 3 forks source link

investigate feasibility of swagger #76

Open davidwallis opened 6 years ago

davidwallis commented 6 years ago

investigate adding swagger to document the api

davidwallis commented 6 years ago

postman might be more practical I think :)

Bounz commented 6 years ago

Well, the main goal of swagger (from my point of view) is to

  1. document the API
  2. provide some kind of contract for 3rd party developers

So swagger would be suitable with HG to replace (or extend) existing documentation of Web API (like https://bounz.github.io/HomeGenie-BE/api/mig/core_api_config.html#2)

davidwallis commented 5 years ago

Yeah I'm just not sure that its going to work with websocketsharp and more suited to WCF / Rest style services?

Bounz commented 5 years ago

Well, I think it's possible, but one of the advantages of Swagger is autogeneration of swagger file and I think it's not possible in the current implementation of the backend. So I think we should return to this question after doing some moves towards asp.net core.