Spring Boot RESTful API Documentation with OpenAPI 3.0 and Swagger-UI using springdoc-openapi

implementation 'org.springdoc:springdoc-openapi-ui:1.5.3'

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.5.3</version>
</dependency>

package dev.simplesolution.rest.entities;

public class Contact {
	private Long id;
	private String firstName;
	private String lastName;
	private String email;
	private String phone;
	private String address;
	
	public Contact() {
		
	}
	
	public Contact(Long id, String firstName, String lastName, String email, String phone, String address) {
		super();
		this.id = id;
		this.firstName = firstName;
		this.lastName = lastName;
		this.email = email;
		this.phone = phone;
		this.address = address;
	}
	
	public Long getId() {
		return id;
	}
	public void setId(Long id) {
		this.id = id;
	}
	public String getFirstName() {
		return firstName;
	}
	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	public String getPhone() {
		return phone;
	}
	public void setPhone(String phone) {
		this.phone = phone;
	}
	public String getAddress() {
		return address;
	}
	public void setAddress(String address) {
		this.address = address;
	}	
}

package dev.simplesolution.rest.repositories;

import java.util.List;

import dev.simplesolution.rest.entities.Contact;

public interface ContactRepository {
	List<Contact> getAll();
	Contact getById(Long id);
	Contact save(Contact newContact);
	Contact update(Contact newContact);
	void delete(Long id);
}

package dev.simplesolution.rest.repositories.impl;

import java.util.ArrayList;
import java.util.List;

import org.springframework.stereotype.Service;

import dev.simplesolution.rest.entities.Contact;
import dev.simplesolution.rest.repositories.ContactRepository;

@Service
public class ContactInMemoryRepository implements ContactRepository {
	
	private static List<Contact> contacts = new ArrayList<>();
	
	public ContactInMemoryRepository() {
		// initialize test data
		contacts.add(new Contact(1L, "John", "Doe", "john@simplesolution.dev", "123-456-789", "address 123, street 1, city 1"));
		contacts.add(new Contact(2L, "Emerson", "Wilks", "emerson@simplesolution.dev", "123-456-788", "address 456, street 2, city 1"));
		contacts.add(new Contact(3L, "Wade", "Savage", "wade@simplesolution.dev", "123-456-787", "address 789, street 3, city 1"));
		contacts.add(new Contact(4L, "Star", "Lott", "star@simplesolution.dev", "123-456-786", "address 234, street 4, city 1"));
		contacts.add(new Contact(5L, "Claudia", "James", "claudia@simplesolution.dev", "123-456-785", "address 678, street 5, city 1"));
	}

	@Override
	public List<Contact> getAll() {
		return contacts;
	}

	@Override
	public Contact getById(Long id) {
		Contact result = contacts.stream()
				.filter(contact -> contact.getId().equals(id))
				.findAny()
				.orElse(null);
		return result;
	}

	@Override
	public Contact save(Contact newContact) {
		contacts.add(newContact);
		return newContact;
	}

	@Override
	public Contact update(Contact newContact) {
		Contact currentContact = contacts.stream()
				.filter(contact -> contact.getId().equals(newContact.getId()))
				.findAny()
				.orElse(null);
		currentContact.setFirstName(newContact.getFirstName());
		currentContact.setLastName(newContact.getLastName());
		currentContact.setEmail(newContact.getEmail());
		currentContact.setPhone(newContact.getPhone());
		currentContact.setAddress(newContact.getAddress());
		return currentContact; 
	}

	@Override
	public void delete(Long id) {
		Contact currentContact = contacts.stream()
				.filter(contact -> contact.getId().equals(id))
				.findAny()
				.orElse(null);
		contacts.remove(currentContact);
	}
}

package dev.simplesolution.rest.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import dev.simplesolution.rest.entities.Contact;
import dev.simplesolution.rest.repositories.ContactRepository;

@RestController
public class ContactController {
	
	@Autowired
	private ContactRepository contactRepository;
	
	@GetMapping("/contacts")
	public List<Contact> getAll() {
		return contactRepository.getAll();
	}

	@GetMapping("/contacts/{id}")
	public Contact getContactById(@PathVariable Long id) {
		return contactRepository.getById(id);
	}
	
	@PostMapping("/contacts")
	public Contact createNewContact(@RequestBody Contact newContact) {
		return contactRepository.save(newContact);
	}
	
	@PutMapping("/contacts/{id}")
	public Contact updateContact(@RequestBody Contact newContact, @PathVariable Long id) {
		newContact.setId(id);
		return contactRepository.update(newContact);
	}
	
	@DeleteMapping("/contacts/{id}")
	public void deleteContact(@PathVariable Long id) {
		contactRepository.delete(id);
	}
}

springdoc.api-docs.path=/v1/api
springdoc.swagger-ui.path=/documentation.html