search

climate-cooperative / home-energy-assessment-database

Documentation, conversions, and data supporting Climate Cooperative's home energy audit and calculation tools.
Apache License 2.0
3 stars 3 forks source link

Create OpenAPI Spec #31

Open rgraue opened 5 months ago

rgraue commented 5 months ago

Description

An OpenAPi spec is a useful tool to describe an api. Describes available paths, and payloads.

https://swagger.io/specification/

Technical Notes

Create endpoint as well, to programmatically provide it. /openapi???

Maybe use https://www.npmjs.com/package/swagger-autogen for auto generating openapi/swagger specs

Risks

[Add Risks]

Related Issues Or Discussions

[...Issues]