Document API via annotations

OurVoiceUSA / HelloVoter

HelloVoter App Suite. Contact your Reps. Canvass for any cause at zero cost.

https://ourvoiceusa.org/hellovoter/

GNU Affero General Public License v3.0

34 stars 33 forks source link

Document API via annotations #53

Open cormander opened 4 years ago

cormander commented 4 years ago

As a developer I want to document the API endpoints in-line to the code so that I can easily keep the API documentation up to date and so that people integrating with the API can do so easily.

This feature is done when:

A framework to annotate node.js code is chosen
Basic documentation of each endpoint is completed.

cormander commented 4 years ago

This looks interesting: https://www.npmjs.com/package/swagger-ui-express

cormander commented 4 years ago

Initial commit https://github.com/OurVoiceUSA/HelloVoter/commit/e9d23f9f09058e2292e4fd5802ee9d3e2b95f857