More cli commands

Author: NotNexx

README.md

@@ -1,7 +1,7 @@
 # Simple API Router
 
 ## Overview
-**Simple API Router** is a lightweight npm package that simplifies setting up Express APIs. It automatically detects all API routes in a defined directory and binds them to an Express app.
+**Simple API Router** is a lightweight npm package that simplifies setting up Express APIs. It automatically detects all API routes in a defined directory and binds them to an Express app. Additionally, it provides an API client generator for frontend integration and automatic API documentation generation.
 
 ## Installation
 
@@ -37,7 +37,7 @@ app.listen(PORT, () => {
 The package allows easy creation of a sample project with a predefined structure:
 
 ```bash
-npx n-sar my-api-project
+npx n-sar create my-api-project
 ```
 
 This creates a new folder `my-api-project` with the following structure:
@@ -59,6 +59,32 @@ npm install
 node server.js
 ```
 
+### 3. Generate an API Client for Frontend Integration
+
+With `n-sar`, you can automatically generate a frontend API client that connects to your backend (localhost or your server domain/IP):
+
+```bash
+npx n-sar export-routes http://localhost:3000
+```
+
+This creates an `apiClient.js` file with functions for each detected route, making API calls simple:
+
+```javascript
+import APIClient from './apiClient';
+
+APIClient.user_get().then(response => console.log(response));
+```
+
+### 4. Generate API Documentation
+
+You can automatically generate API documentation based on your routes:
+
+```bash
+npx n-sar generate-docs
+```
+
+This will create an `API_DOCS.md` file containing all detected API endpoints and their methods.
+
 ## API Definitions
 
 The package expects API files to be located in the `api/` directory. Each file corresponds to a route. Example:

bin/cli.js

@@ -43,6 +43,15 @@ module.exports = (app) => {
     'api/user.js': `const express = require('express');
 const router = express.Router();
 
+/**
+ * @openapi
+ * /user:
+ *   get:
+ *     description: Returns a user endpoint
+ *     responses:
+ *       200:
+ *         description: A user object
+ */
 router.get('/', (req, res) => {
     res.json({ message: 'User endpoint' });
 });
@@ -55,21 +64,112 @@ function createProject() {
         console.error('Error: Project folder already exists.');
         process.exit(1);
     }
-    
+
     fs.mkdirSync(projectPath, { recursive: true });
     fs.mkdirSync(path.join(projectPath, 'api'));
-    
+
     for (const [file, content] of Object.entries(files)) {
         const filePath = path.join(projectPath, file);
         fs.mkdirSync(path.dirname(filePath), { recursive: true });
         fs.writeFileSync(filePath, content);
     }
-    
+
     console.log('Example project created!');
     console.log(`Run:
     cd ${projectName}
     npm install
     node server.js`);
 }
 
-createProject();
+function scanRoutes(directory, baseRoute = '') {
+    let routes = [];
+    fs.readdirSync(directory).forEach(file => {
+        const fullPath = path.join(directory, file);
+        const routePath = `${baseRoute}/${file.replace('.js', '')}`;
+
+        if (fs.statSync(fullPath).isDirectory()) {
+            routes = routes.concat(scanRoutes(fullPath, routePath));
+        } else if (file.endsWith('.js') && file !== 'router.js') {
+            routes.push(routePath);
+        }
+    });
+    return routes;
+}
+
+function getRouteMethod(routeFile) {
+    if (!fs.existsSync(routeFile)) return [];
+
+    const content = fs.readFileSync(routeFile, 'utf8');
+    let methods = [];
+
+    if (content.includes("router.get(")) methods.push("get");
+    if (content.includes("router.post(")) methods.push("post");
+    if (content.includes("router.put(")) methods.push("put");
+    if (content.includes("router.delete(")) methods.push("delete");
+
+    return methods;
+}
+
+function generateAPIClient(routes, outputPath, baseURL) {
+    const clientCode = `class APIClient {
+    constructor(baseURL) {
+        this.baseURL = baseURL;
+    }
+
+    async request(endpoint, options = {}) {
+        const response = await fetch(
+            \`\${this.baseURL}\${endpoint}\`,
+            { ...options, headers: { 'Content-Type': 'application/json', ...options.headers } }
+        );
+        return response.json();
+    }
+
+${routes
+    .map(route => {
+        const routeFile = path.join(process.cwd(), 'api', route.replace(/\//g, path.sep) + '.js');
+        const methods = getRouteMethod(routeFile);
+
+        return methods
+            .map(method => `    async ${route.replace(/\//g, '_').replace('-', '_')}_${method}() {
+        return this.request('${route}', { method: '${method.toUpperCase()}' });
+    }`)
+            .join('\n');
+    })
+    .join('\n')}
+}
+
+export default new APIClient('${baseURL}');`;
+
+    fs.writeFileSync(outputPath, clientCode);
+    console.log(`API client generated at ${outputPath}`);
+}
+
+function generateDocs() {
+    const apiDir = path.join(process.cwd(), 'api');
+    if (!fs.existsSync(apiDir)) {
+        console.error('Error: API directory does not exist.');
+        process.exit(1);
+    }
+
+    const routes = scanRoutes(apiDir);
+    let docContent = '# API Documentation\n\n## Endpoints\n';
+
+    routes.forEach(route => {
+        docContent += `### \`${route}\`\n- **GET**: Fetch data from ${route}\n- **POST**: Send data to ${route}\n- **PUT**: Update data at ${route}\n- **DELETE**: Remove data at ${route}\n\n`;
+    });
+
+    fs.writeFileSync(path.join(process.cwd(), 'API_DOCS.md'), docContent);
+    console.log('API_DOCS.md generated successfully.');
+}
+
+if (process.argv[2] === 'export-routes') {
+    const apiDir = path.join(process.cwd(), 'api');
+    const routes = scanRoutes(apiDir);
+    const outputPath = path.join(process.cwd(), 'apiClient.js');
+    const baseURL = process.argv[3] || 'http://localhost:3000';
+    generateAPIClient(routes, outputPath, baseURL);
+} else if (process.argv[2] === 'generate-docs') {
+    generateDocs();
+} else {
+    createProject();
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@notnexx/n-sar",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "A simple API router for Express.js",
     "main": "index.js",
     "keywords": [
@@ -11,6 +11,7 @@
     "author": "NotNexx",
     "license": "MIT",
     "dependencies": {
+        "@notnexx/n-sar": "^1.0.2",
         "express": "^4.21.2"
     },
     "devDependencies": {