|
1 | 1 | Changelog |
2 | 2 | ========= |
3 | 3 |
|
4 | | -Features & Improvements |
5 | | ------------------------ |
| 4 | +## [0.2.0] - 2025-01-09 |
6 | 5 |
|
7 | | -#### 2019-1-29 |
| 6 | +### 🎉 Major Release - Complete Rewrite |
| 7 | + |
| 8 | +#### Added |
| 9 | +- **CLI Interface**: New `api-stub-gen` command with subcommands (`generate`, `watch`, `serve`) |
| 10 | +- **FastAPI Support**: Generate FastAPI applications with async support and auto-docs |
| 11 | +- **Watch Mode**: Auto-regenerate stubs when markdown files change |
| 12 | +- **Configuration Files**: YAML config file support (`.stubrc.yml`) |
| 13 | +- **OpenAPI Generation**: Auto-generate OpenAPI 3.0 specifications |
| 14 | +- **CORS Support**: Built-in CORS for Flask and FastAPI apps |
| 15 | +- **Hot Reload**: Debug mode with auto-reload enabled by default |
| 16 | +- **Template System**: Jinja2-based code generation (replaces string concatenation) |
| 17 | +- **Validation**: Comprehensive endpoint validation with helpful error messages |
| 18 | +- **Docker Support**: Dockerfile and docker-compose.yml for containerization |
| 19 | +- **Type Hints**: Full type annotations throughout the codebase |
| 20 | +- **Test Coverage**: Comprehensive test suite for all new features |
| 21 | +- **Health Endpoint**: Built-in `/health` endpoint for monitoring |
| 22 | + |
| 23 | +#### Changed |
| 24 | +- **Python Version**: Minimum Python 3.10 (was 3.7) |
| 25 | +- **Dependencies**: Updated to latest versions (Flask 3.0+, pytest 7.4+) |
| 26 | +- **CI/CD**: Migrated from Travis CI to GitHub Actions |
| 27 | +- **Linting**: Replaced flake8 with Ruff for faster linting and formatting |
| 28 | +- **Project Structure**: Added `pyproject.toml` following PEP 621 standards |
| 29 | +- **Documentation**: Complete README rewrite with examples and comparisons |
| 30 | + |
| 31 | +#### Deprecated |
| 32 | +- Direct usage of `serialize_data.py` and `create_mock_endpoints.py` (use CLI instead) |
| 33 | +- Pipenv as primary dependency manager (pip recommended) |
| 34 | + |
| 35 | +#### Fixed |
| 36 | +- Better error handling for malformed markdown |
| 37 | +- Proper validation of HTTP methods and endpoint formats |
| 38 | +- Unicode handling in endpoint descriptions |
| 39 | + |
| 40 | +## [0.1.0] - 2019-01-29 |
| 41 | + |
| 42 | +### Features & Improvements |
8 | 43 |
|
9 | 44 | - Allow `serialize_data.py` accept path for proposed endpoints docs as command line argument. ([@mansiag]) |
10 | 45 |
|
|
0 commit comments