TOPIC 09 : Automatic Documentation of REST API using AI PFE

Project overview

• This PFE aims to design and implement an AI-powered solution to automatically generate detailed documentation for C# REST APIs as part of a major migration project in the German banking sector.
• The system will parse C# REST API projects, extract XML comments and metadata, identify endpoints, parameters and return types, and generate human-readable descriptions and example requests/responses using AI/LLM integration.

Technical stack & tools

• C# (.NET 8), JSON/XML, REST API, Swagger (JSON/YAML), HTML/PDF generation, Markdown.
• AI/LLM integration for natural language generation and example synthesis; Angular for dashboard/frontend and export UI.

Responsibilities and tasks

• Parse C# REST API codebases to identify all endpoints, parameters, models and return types and enrich them with extracted XML comments.
• Integrate an AI/LLM component to generate human-readable endpoint descriptions and example requests/responses, and allow manual edits via a UI.
• Implement export functionality to produce Swagger JSON/YAML, HTML, PDF and Markdown documentation formats.
• Develop an Angular dashboard to visualize endpoints, enable edits and trigger exports; ensure edits persist into exported formats.

Expected deliverables

• A working prototype that parses C# REST API projects and produces complete API documentation enriched by AI-generated descriptions and examples.
• Export modules producing Swagger (JSON/YAML), HTML, PDF and Markdown outputs, plus an Angular dashboard for visualization and editing.
• Documentation of the solution architecture, integration points for the LLM, and usage instructions for the migration project team.

Internship details & application

• Pre-employment Internship — Duration: 6 months (listed as 4-6 months), Number of interns: 1, Paid internship.
• To apply, send your application referencing this topic to stages@binitns.com including CV and a short motivation explaining relevant experience with C#, REST APIs and AI/LLM tools.