Add file doc for apiRouter.js

sharetribe · Feb 12, 2020 · cf61a51 · cf61a51
1 parent 531b486
commit cf61a51
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/server/apiRouter.js b/server/apiRouter.js
@@ -1,3 +1,11 @@
+/**
+ * This file contains server side endpoints that can be used to perform backend
+ * tasks that can not be handled in the browser.
+ *
+ * The endpoints should not clash with the application routes. Therefore, the
+ * enpoints are prefixed in the main server where this file is used.
+ */
+
 const http = require('http');
 const https = require('https');
 const express = require('express');