accept URI_PATH for living behind a reverse proxy

Author: Developer

Makefile

@@ -7,7 +7,11 @@ help:
 
 .PHONY: docker
 docker: ## Build the docker container
-	docker build -t mobiledoc .
+	docker build -t rest-mobiledoc .
+
+.PHONY: docker-run
+docker-run: ## Run the docker container
+	docker run --rm -e URI_PATH=/mobiledoc/ -it -p 3000:3000 rest-mobiledoc
 
 .PHONY: test
 test: ## Run the tests

README.md

@@ -128,6 +128,21 @@ Example request body:
 
 The API will respond with the converted Mobiledoc content.
 
+## API Usage Example
+
+Here's an example of how to use the API with curl:
+
+```bash
+curl -X POST https://api.joat.tools \
+     -H "Content-Type: application/json" \
+     -d '{
+       "source": "markdown",
+       "payload": "# Welcome to REST-mobiledoc\n\nThis is a sample Markdown document.\n\n## Features\n\n- Converts Markdown to Mobiledoc\n- Easy to use API\n- Lightweight and fast"
+     }'
+```
+
+This command sends a POST request to the API with a Markdown payload. The API should respond with the converted Mobiledoc content.
+
 
 ## Contributing
 

server.js

@@ -10,6 +10,9 @@ function createApp() {
   const app = express();
   app.use(bodyParser.json());
 
+  // Get the URI_PATH from environment variables, default to '/' if not set
+  const uriPath = process.env.URI_PATH || '/';
+
   // Swagger definition
   const swaggerOptions = {
     definition: {
@@ -19,12 +22,18 @@ function createApp() {
         version: '1.0.0',
         description: 'A simple Express API to convert HTML and Markdown to Mobiledoc',
       },
+      servers: [
+        {
+          url: uriPath,
+          description: 'Dynamic base path',
+        },
+      ],
     },
     apis: ['./server.js'], // files containing annotations as above
   };
 
   const swaggerSpec = swaggerJsdoc(swaggerOptions);
-  app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+  app.use(`${uriPath}api-docs`, swaggerUi.serve, swaggerUi.setup(swaggerSpec));
 
   /**
    * @swagger
@@ -61,7 +70,7 @@ function createApp() {
    *       500:
    *         description: Internal server error
    */
-  app.post('/', (req, res) => {
+  app.post(`${uriPath}`, (req, res) => {
     try {
       const { source, payload } = req.body;
       console.log('Received request:', { source, payload });
@@ -126,10 +135,12 @@ function convertToMobiledoc(content, source) {
 if (require.main === module) {
   const app = createApp();
   const port = process.env.PORT || 3000;
+  const uriPath = process.env.URI_PATH || '/';
+
 
   const server = app.listen(port, () => {
-    console.log(`Server running at http://localhost:${port}`);
-    console.log(`API documentation available at http://localhost:${port}/api-docs`);
+    console.log(`Server running at http://localhost:${port}${uriPath}`);
+    console.log(`API documentation available at http://localhost:${port}${uriPath}api-docs`);
   });
 
   // Handle server errors