An open API service indexing awesome lists of open source software.

https://github.com/juanpablo70/ieti-swagger

Setting up Swagger in a project and generating documentation for your REST API
https://github.com/juanpablo70/ieti-swagger

java rest-api swagger

Last synced: over 1 year ago
JSON representation

Setting up Swagger in a project and generating documentation for your REST API

Awesome Lists containing this project

README

          

## Codelab ๐Ÿงช Implementing a REST API Service

![API Documentation](img.png)

Implement different REST API Services to support a store products management system, implementing each CRUD Operation
with Pagination for each service (Users and Products):

- Create
- Read
- Update
- Delete

๐Ÿ‘‰ Aim to reach the [Glory of Rest](https://martinfowler.com/articles/richardsonMaturityModel.html).

๐Ÿ‘‰ Use the correct methods and status codes
of [HTTP Protocol](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP).

๐Ÿ‘‰ It should have at least have
the [Level 2 - HTTP Verbs of Richardson Maturity Model](https://martinfowler.com/articles/richardsonMaturityModel.html).

**Programming Language**:- Java.

**Framework:** Spring Boot.

**Database:** MongoDB.

**Learning Objectives**

- [ ] Use the Richardson Maturity Model to implement a REST API Service.
- [ ] Implement a REST API Service using Spring Boot.
- [ ] Implement CRUD Operations.

## Detail Orientation ๐Ÿคน๐Ÿฝ

Good code is about details. Follow each step carefully and make sure your code is clean and readable.

**Main Topics**

* Microservices.
* REST API.
* MongoDB.
* Java.
* Spring Boot.

## Codelab ๐Ÿงช

๐Ÿ—ฃ๏ธ "I hear and I forget I see and I remember I do and I understand." Confucius