basics's Introduction

Basics

This is a collection of sample projects in several languages I like to work with. The example shows a basic version of a REST service that allows adding, listing and retrieving a simple Customer record. The Scala version also offers a gRPC api.

Setup

Create a Mysql database, e.g. using Docker.

see https://spring.io/guides/gs/accessing-data-mysql

create database for demo:

docker exec -it some-mysql bash

mysql --password
# password = my-secret-pw

create database db_example;
create user 'springuser'@'%' identified by 'ThePassword';
grant all on db_example.* to 'springuser'@'%';

Test

The implementation in each language offers the following endpoints:

Endpoint	Description
GET /customers/all	Json list of all customers
GET /customers/{id}	Query customer by uuid
POST /customers	Save a new customer

Save a customer

curl -v -d '{"name":"i1", "email": "a@com"}' \
-H 'Content-Type: application/json' \
-X POST localhost:8080/customers

Get customer by id

curl -v localhost:8080/customers/4303cdaa-1504-4271-a614-1106daa2e83

List all customers

curl -v localhost:8080/customers/

Note: the Kotlin version currently requires a trailing / when POSTing a new customer.

Actuator

The actuator works for Java and Kotlin and shows documentation for each endpoint

curl http://localhost:8080/api/actuator/mappings
# endpoints, add /api to get the full url
curl http://localhost:8080/api/actuator/mappings |jq | grep predicate

Recommend Projects