Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

Java REST API with OpenAPI/Swagger

A RESTful API project built with Java, designed and documented using OpenAPI/Swagger specifications to establish clear interface contracts for frontend-backend integration.

Overview

This project demonstrates the design and documentation of RESTful API endpoints following REST principles and OpenAPI standards. The goal is to produce structured, readable API documentation that reduces ambiguity and improves collaboration across development teams.

Tech Stack

  • Language: Java
  • API Documentation: OpenAPI 3.0 / Swagger UI
  • Build Tool: Maven
  • Tools: IntelliJ IDEA, Git

Features

  • RESTful endpoint design following REST conventions
  • OpenAPI/Swagger documentation for all endpoints
  • Clear request/response schema definitions
  • Structured API contracts for frontend-backend integration

Project Status

🚧 In Progress — Currently implementing core API endpoints and Swagger documentation.

Getting Started

git clone https://github.com/MocHuy/java-rest-api-swagger

Setup instructions will be updated as development progresses.

Author

Lai Moc Huy — LinkedIn

About

A RESTful API project built with Java, documented using OpenAPI/Swagger specifications.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors