froggy-docs 1.1.1 → 1.1.3

package/frontend/web/froggy_docs.json

@@ -89,15 +89,31 @@
     },
     "/api/login": {
       "post": {
-        "summary": "User login endpoint with inline JSON body",
+        "summary": "User login",
         "responses": {
           "200": {
             "description": "Successful response"
           }
         },
-        "tags": [
-          "Auth"
-        ]
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "username": {
+                    "type": "string",
+                    "description": "Inferred from JSON"
+                  },
+                  "password": {
+                    "type": "string",
+                    "description": "Inferred from JSON"
+                  }
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/api/register": {
@@ -112,6 +128,265 @@
           "Auth"
         ]
       }
+    },
+    "/api/users": {
+      "get": {
+        "summary": "List users with pagination",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Page number",
+            "schema": {
+              "type": "int",
+              "default": 1
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Items per page",
+            "schema": {
+              "type": "int",
+              "default": 10
+            }
+          },
+          {
+            "name": "search",
+            "in": "query",
+            "description": "Search term",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ]
+      },
+      "post": {
+        "summary": "Create user",
+        "responses": {
+          "201": {
+            "description": "User created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                },
+                "example": {
+                  "id": 1
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                },
+                "example": {
+                  "error": "Invalid input"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/users/1": {
+      "delete": {
+        "summary": "Delete a user",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ]
+      }
+    },
+    "/api/products": {
+      "get": {
+        "summary": "List products",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "tags": [
+          "Products",
+          "Catalog"
+        ]
+      }
+    },
+    "/api/upload": {
+      "post": {
+        "summary": "Upload user avatar",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "avatar": {
+                    "type": "string",
+                    "format": "binary",
+                    "description": "User profile picture"
+                  },
+                  "document": {
+                    "type": "string",
+                    "format": "binary",
+                    "description": "Optional PDF attachment"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/profile": {
+      "post": {
+        "summary": "Update user profile with avatar",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "User display name"
+                  },
+                  "bio": {
+                    "type": "string",
+                    "description": "User biography"
+                  },
+                  "avatar": {
+                    "type": "string",
+                    "format": "binary",
+                    "description": "Profile picture"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/data": {
+      "get": {
+        "summary": "Get data with custom headers",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "parameters": [
+          {
+            "name": "X-Request-ID",
+            "in": "header",
+            "description": "Optional trace ID",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Api-Version",
+            "in": "header",
+            "description": "API version",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ]
+      }
+    },
+    "/api/items": {
+      "post": {
+        "summary": "Create item in Go",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "type": "string",
+                    "description": "Item title"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/ignored": {
+      "get": {
+        "summary": "This should be ignored",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    },
+    "/api/temp": {
+      "get": {
+        "summary": "Temporary endpoint",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    },
+    "/api/test": {
+      "get": {
+        "summary": "Test endpoint",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        },
+        "tags": [
+          "Test"
+        ]
+      }
+    },
+    "/api/import": {
+      "post": {
+        "summary": "Import from body file",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -129,6 +404,15 @@
     },
     {
       "name": "Auth"
+    },
+    {
+      "name": "Products"
+    },
+    {
+      "name": "Catalog"
+    },
+    {
+      "name": "Test"
     }
   ]
 }

package/lib/froggy_docs.dart

@@ -1,2 +1,3 @@
 export 'src/watcher_engine.dart';
 export 'src/parser_engine.dart';
+export 'src/cli_runner.dart';

package/lib/src/cli_runner.dart

@@ -0,0 +1,123 @@
+import 'dart:io';
+import 'package:args/args.dart';
+import 'package:froggy_docs/src/watcher_engine.dart';
+import 'package:froggy_docs/src/web_server.dart';
+import 'package:froggy_docs/src/parser_engine.dart';
+
+class CliRunner {
+  void run(List<String> arguments) async {
+    final parser = ArgParser();
+    parser.addCommand('watch');
+    parser.addCommand('serve');
+    parser.addCommand('build');
+    parser.addOption(
+      'port',
+      abbr: 'p',
+      help: 'Port for server',
+      defaultsTo: '8080',
+    );
+    parser.addOption(
+      'proxy',
+      abbr: 'x',
+      help: 'Proxy API requests to this URL (e.g., http://localhost:3000)',
+      defaultsTo: '',
+    );
+    parser.addOption(
+      'output',
+      abbr: 'o',
+      help: 'Output path for generated JSON spec (default: frontend/web/froggy_docs.json)',
+      defaultsTo: 'frontend/web/froggy_docs.json',
+    );
+    parser.addOption(
+      'ignore',
+      help: 'Glob pattern for paths to exclude from watching (e.g., "**/*.g.dart")',
+      defaultsTo: '',
+    );
+
+    try {
+      final results = parser.parse(arguments);
+
+      final outputPath = results['output'] as String;
+      final ignorePattern = results['ignore'] as String;
+
+      if (results.command?.name == 'watch') {
+        print('🐸 FroggyDocs is watching your API project...');
+        final watcher = WatcherEngine(outputPath: outputPath, ignorePattern: ignorePattern);
+        watcher.startWatching(Directory.current.path);
+      } else if (results.command?.name == 'serve') {
+        final port = int.parse(results['port'] as String);
+        final proxyUrl = results['proxy'] as String;
+        print('🐸 Starting FroggyDocs server with live reload...');
+        if (proxyUrl.isNotEmpty) {
+          print('🔄 Proxy enabled: API requests will be forwarded to $proxyUrl');
+        }
+
+        await startServer(port: port, proxyUrl: proxyUrl);
+        final watcher = WatcherEngine(outputPath: outputPath, ignorePattern: ignorePattern);
+        watcher.startWatching(Directory.current.path);
+      } else if (results.command?.name == 'build') {
+        print('🐸 Building static FroggyDocs site...');
+        final parser = ParserEngine();
+        parser.setOutputPath(outputPath);
+        _buildStaticSite(parser, Directory.current.path);
+        print('✅ Build complete. Output: $outputPath');
+      } else {
+        _printHelp();
+      }
+    } catch (e) {
+      print('Error: ${e.toString()}');
+      exit(1);
+    }
+  }
+
+  void _buildStaticSite(ParserEngine parser, String directoryPath) {
+    final dir = Directory(directoryPath);
+    try {
+      dir.listSync(recursive: true).forEach((entity) {
+        if (entity is File) {
+          final normalizedPath = entity.path.replaceAll('\\', '/');
+          if (!_shouldIgnore(normalizedPath)) {
+            parser.parseFile(entity.path);
+          }
+        }
+      });
+    } catch (e) {
+      print('⚠️  Warning during build: $e');
+    }
+  }
+
+  bool _shouldIgnore(String path) {
+    return path.contains('/.dart_tool/') ||
+        path.contains('/frontend/') ||
+        path.contains('/node_modules/') ||
+        path.contains('/.git/') ||
+        path.endsWith('.json') ||
+        path.endsWith('.md');
+  }
+
+  void _printHelp() {
+    print('''
+🐸 FroggyDocs v1.0.0
+
+Usage:
+  froggy_docs serve       Start server with live documentation
+  froggy_docs watch       Watch for changes and regenerate docs
+  froggy_docs build       Generate static documentation without starting server
+
+Options:
+  -p, --port <port>       Port number (default: 8080)
+  -x, --proxy <url>       Proxy API requests to this URL
+  -o, --output <path>     Output path for generated JSON spec
+                          (default: frontend/web/froggy_docs.json)
+  --ignore <glob>         Glob pattern for paths to exclude from watching
+                          (e.g., "**/*.g.dart")
+  -h, --help              Show this help message
+
+Examples:
+  froggy_docs serve --port 3000
+  froggy_docs serve --output docs/api.json
+  froggy_docs build --output docs/froggy_docs.json
+  froggy_docs watch --ignore "**/*.g.dart"
+''');
+  }
+}