Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.

APIv3 Wishlist

Atul Varma edited this page Jun 25, 2013 · 5 revisions

API v1 was for Thimble, API v2 was for Chicago Summer of Learning, and v3 will be the thing that combines the best of both and learns from their mistakes without falling prey to second system syndrome.

Currently v3 is only a distant dream, so here is a wishlist for it.

Design

  • Open Badger could know more about assessment. Assuming #222 goes through, the groundwork will be laid for associating evidence with a badge. It could be cool to make assessment a "plugin" sort of thing so it could go though Aestimia, or some other assessment workflow, and then build a nice evidence page to include in the assertion.

Implementation

  • Having used both mocha and node-tap, I vastly prefer the former. Unless we have a really compelling reason to use node-tap, I'd like to use mocha if possible. -AV
  • v3 should do test coverage reporting, but it involves structuring the project in a particular way, so it's a lot easier to do at the beginning of a project. See express and aestimia's repositories for examples of how this is done. -AV
  • I'm not a huge fan of routes/render.js in v2--it mostly seems to make the app logic harder to follow, without much benefit (though perhaps I am just not seeing the benefit). -AV
  • Consider using Object Factories instead of fixtures for testing, and make sure database state is reset between each test (not each suite).
Clone this wiki locally