Skip to content

Commit 1b0758a

Browse files
committed
docs: add swagger api documentation link to readme
1 parent 2e6a3c1 commit 1b0758a

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,18 @@ graph TD
3737
- DevOps: Containerized with Docker for seamless environment synchronization.
3838

3939
## Key Features
40+
- **AI-Powered OCR**: Semantic extraction using Gemini 2.5 Flash.
41+
- **Interactive API Docs**: Explore and test endpoints via Swagger UI.
42+
- **Real-time Analytics**: Dashboard with margin tracking and stats.
43+
- **Smart Validation**: VAT/NIP consistency and anomaly checks.
44+
45+
## API Documentation
46+
47+
The project includes interactive API documentation powered by Swagger. When the server is running, you can explore the endpoints and test requests directly from your browser:
48+
49+
👉 **[http://localhost:5000/api-docs](http://localhost:5000/api-docs)**
50+
51+
This interface provides detailed information about request schemas, authentication requirements, and example responses.
4052

4153
- Semantic OCR Extraction: Automatically pulls Vendor Name, Date, NIP, Net/Gross, and Category using Gemini's vision-to-json capabilities.
4254
- Intelligent Anomaly Detection:

0 commit comments

Comments
 (0)