https://github.com/maxjdev/first-api_rest-documented-with-spring_web-and-swagger

Project: Creating first Documented Rest API using Spring Web and Swagger
https://github.com/maxjdev/first-api_rest-documented-with-spring_web-and-swagger

java java17 lombok maven postman spring spring-boot swagger-ui swagger2

Last synced: 9 days ago
JSON representation

Project: Creating first Documented Rest API using Spring Web and Swagger

• Host: GitHub
• URL: https://github.com/maxjdev/first-api_rest-documented-with-spring_web-and-swagger
• Owner: maxjdev
• Created: 2024-02-15T12:40:47.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-17T20:39:21.000Z (8 months ago)
• Last Synced: 2024-03-17T21:50:35.589Z (8 months ago)
• Topics: java, java17, lombok, maven, postman, spring, spring-boot, swagger-ui, swagger2
• Language: Java
• Homepage:
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
First API Rest documented with Spring-Web, Swagger and Postman


### Techs Used

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)

![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)

![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)



## Description

The Rest API is an approach to developing web services that uses the principles of the HTTP protocol. When creating a REST API, developers use Rest Controllers to define endpoints that handle different HTTP requests. Furthermore, it is important to document the API to facilitate its understanding and use, with Swagger being a common tool for this task. To ensure proper handling of business exceptions, it is possible to enable handlers that capture and handle specific errors related to the application's business logic.

## How to Start the Project

- **Clone the repository:**

```bash

git clone https://github.com/your-username/repository-name.git

```

- **Open the project directory:**

```bash

cd repository-name

```

- **Install project dependencies:**

```bash

mvn install

```

- **Start:**

```bash

mvn spring-boot:run

```

## Contributing

We welcome and appreciate your contributions to this project! Whether you have suggestions, bug fixes, or new features you'd like to add, please feel free to fork this repository.

### How to Contribute

1. Fork the project.

2. Create a branch for your contribution: `git checkout -b my-contribution`.

3. Make your changes and commit: `git commit -m 'Add my contribution'`.

4. Push to your branch: `git push origin my-contribution`.

5. Open a pull request for review.

## Feedback and Issues

If you have contributions, suggestions, or feedback, feel free to open an issue.