Overview
The Text Analysis API is a web API implemented in C# using ASP.NET Core. It accepts a text file via a POST request and returns the top 8 longest words found in the file. The API processes the text by normalizing words and removing punctuation marks to ensure no duplicates are returned. API documentation is generated with Swagger.
I developed this project as part of a technical assessment during an interview process. I was tasked with building an API that analyzes a given text file using a programming language of my choice to showcase my object-oriented design and API development skills.
Code and Setup Instructions
| GitHub Repository: | https://github.com/masaki9/TextAnalysisAPI |
Features
- File Upload: Accepts a text file via a POST request.
- Longest Words Extraction: Returns the top 8 longest words from the provided text.
- Data Cleaning: Normalizes words and removes punctuation to eliminate duplicates.
- Swagger Integration: Provides comprehensive API documentation and testing capabilities.
Technical Details
Implementation
The project follows an MVC architecture and is implemented in C# using ASP.NET Core. The code is organized into the following layers:
- Controller:
- TextAnalysisController.cs – Handles incoming HTTP requests and delegates processing to the service layer.
- Service:
- ITextAnalysisService.cs – Defines the contract for text analysis operations.
- TextAnalysisService.cs – Implements the logic to process the text file and extract the longest words.
- Model:
- Word.cs – Represents a word in the text file, including its text and length.
- Application Entry Point:
- Program.cs – Registers the text analysis service as Scoped (one instance per HTTP request), sets up Swagger, and starts the application.
Architecture Diagram
The following UML diagram illustrates the high-level architecture of the API:
Architecture Diagram
API Documentation
Swagger is integrated to automatically generate interactive API documentation. It enables you to test endpoints directly from your browser.
Swagger
Conclusion
The Text Analysis API demonstrates my ability to develop a REST API using C# and ASP.NET Core. This project highlights my object-oriented design skills as well as my proficiency in building clean, maintainable code. I have integrated Swagger to generate interactive API documentation, making it easy to explore and test the API.
Since this project was developed as part of a technical assessment, I had limited time to build it. For future enhancements, I would love to support additional text analysis capabilities, such as N-grams and sentiment analysis.