https://github.com/thanthtooaung-coding/api-documentation-generator
This project is API Documentation Generator using Spring Boot and Thymeleaf.
https://github.com/thanthtooaung-coding/api-documentation-generator
spring-boot thymeleaf
Last synced: 9 months ago
JSON representation
This project is API Documentation Generator using Spring Boot and Thymeleaf.
- Host: GitHub
- URL: https://github.com/thanthtooaung-coding/api-documentation-generator
- Owner: thanthtooaung-coding
- License: mit
- Created: 2025-01-16T14:48:19.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-01-18T17:33:32.000Z (12 months ago)
- Last Synced: 2025-03-28T04:37:12.299Z (10 months ago)
- Topics: spring-boot, thymeleaf
- Language: HTML
- Homepage: https://api-documentation-generator.onrender.com
- Size: 36.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Documentation Generator
**API Documentation Generator** is a project built using **Spring Boot** to simplify and automate the generation of API documentation for your projects.
## Table of Contents
- [About](#about)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Application](#running-the-application)
- [License](#license)
- [Contact](#contact)
---
## About
The **API Documentation Generator** streamlines the process of creating consistent and developer-friendly API documentation. It integrates seamlessly with Spring Boot applications, allowing you to focus on building your APIs while automating the documentation process.
---
## Features
- Automated generation of API documentation.
- Customizable API descriptions and metadata.
---
## Technologies Used
- **Java 21**
- **Spring Boot 3.4.1**
- **Maven**
---
## Getting Started
### Prerequisites
- **Java 21**: Ensure you have Java installed. [Download here](https://www.oracle.com/java/technologies/javase-downloads.html).
- **Maven**: For managing dependencies and building the project. [Download here](https://maven.apache.org/download.cgi).
- **Git**: Version control to clone the repository.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/thanthtooaung-coding/api-documentation-generator.git
cd api-documentation-generator
```
2. Install dependencies:
```bash
mvn clean install
```
### Running the Application
Start the Spring Boot application:
```bash
mvn spring-boot:run
```
The application will be available at: `http://localhost:8080`.
---
## License
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.
---
## Contact
- **Author**: Thant Htoo Aung
- **Email**: thanthtoo1285@gmail.com
- **GitHub**: [thanthtooaung-coding](https://github.com/thanthtooaung-coding)
---