toxdes / testiny-backend

An API back-end for https://testiny.live
https://api.testiny.live
GNU General Public License v3.0
0 stars 0 forks source link

Add documentation for the API #6

Open toxdes opened 3 years ago

toxdes commented 3 years ago

API isn't documented, and changes every now and then, because it's still about to settle down.

A good documentation of the API would help, although I'm not sure if I should be writing it manually or just use some sort of doc-generator.

toxdes commented 3 years ago

There's a few options.

  1. Use swagger and jsdoc to document the methods inline.
  2. Use prisma-doc-generator, but this will generate docs for the prisma schema, and not for the API routes.
  3. Use custom markdown file, and use a static site generator like docasaurus.