How rezanasirian/simple-api-generator works
Project type and purpose
• This is a full-stack web application (“Simple API Generator”) built with Flask (Python 3.8+).
• It provides a browser-based UI for non-developers to build, test, document and manage RESTful APIs without writing server code.
• The README confirms features like drag-and-drop API builder, user auth, role-based access, automatic Swagger/OpenAPI docs, database integration, logging, versioning, and multi-environment configuration.
File structure
• Top-level directories:
• app/ – core application package
• config/ – JSON and Python configuration files
• migrations/ – database migration scripts (Alembic style)
• instance/ – runtime SQLite database
• exports/ – generated Swagger JSON
• templates/ – Jinja2 HTML templates organized by feature
• services/, utils/, models.py, middleware/ under app/ implement business logic, helpers, and cross-cutting concerns
• app/__init__.py wires up the Flask app, loads blueprints (api, auth, dashboard, admin).
• app/api/routes holds API endpoints, including generator logic and documentation endpoints.
• app/services encapsulate database connections, query builder, user management, logging.
• app/middleware implements request-level authentication and metrics gathering.
• run.py / flask CLI is the entry point.
• config files (config.py, ApiDoc.json, db_config.json) define environment settings and default API doc structure.
README additional insights
• Mentions multi-environment via .env variables (SECRET_KEY, FLASK_ENV, DATABASE_URL, mail settings).
• Deployment options: Heroku, Docker.
• Testing with pytest and coverage.