Openapi on Micha Kops' Tech Notes

AsciiDoc Snippets

Fri, 10 May 2019 00:00:00 +0200

AsciiDoc Syntax and Features

Using AsciiMath

Include stem into document header

:stem:

Then use inline, e.g.:

stem:[sqrt(4) = 2]

or as block

[stem]
++++
sum_(i=1)^n i^3=((n(n+1))/2)^2
++++

AsciiMath Syntax

Collapsible Blocks/Sections

.Click to show the content
[%collapsible]
====
Long content here...
====

Source: Asciidoctor Docs

Tools and Ecosystem

Docker / Podman Container

Including stuff like:

Asciidoctor
Asciidoctor Diagram with ERD and Graphviz integration (supports plantuml and graphiz diagrams)
Asciidoctor PDF
Asciidoctor EPUB3
Asciidoctor FB2
Asciidoctor Mathematical
Asciidoctor reveal.js
AsciiMath
Source highlighting using Rouge, CodeRay or Pygments
Asciidoctor Confluence
Asciidoctor Bibtex
Asciidoctor Kroki
Asciidoctor Reducer

Testing OpenAPI Swagger Schema Compliance with Java, JUnit and assertj-swagger

Fri, 31 Aug 2018 00:00:00 +0200

The OpenAPI and Swagger API description format are becoming important standards to specify API contracts for RESTful web services and the Microservices trend pushes the need for such contracts even further.

Therefore arises the need for software architects, testers and developers to write tests to verify if an exposed API follows such a specified contract.

In the following tutorial I will demonstrate a setup with Java, Maven, JUnit and the designated contract-testing-library, assertj-swagger that verifies the validity of such a contract exposed by a Spring Boot application against a local stored definition.

Java Snippets

Mon, 01 Mar 2010 00:00:00 +0100

Remote Debug a Pod’s Java Process

Simple steps for remote debugging a Java process running on a k8 pod:

Edit deployment and add the following parameters to the Java start line: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=127.0.0.1:5005

Also add the following port mapping at the section container → ports in the deployment:
```
- containerPort: 5005
  protocol: TCP
```
Safe, wait for the new pods and then add a port forward for port 5005 for this pod:
```
kubectl port-forward podname 5005
```

Linux Snippets

Mon, 01 Mar 2010 00:00:00 +0100

These are not only linux snippets but also bash snippets and snippets using tools that run under Linux, *nix or sometimes even MacOSX, I should reorder this article someday ;)

Bash Scripting

Settings for more reliable bash scripts

set -euo pipefail

this gives us …

-e: exit script if a single command fails
-u: exit script if an unset variable is used
-o pipefail: return value of a pipeline is the status of the last command to exit with a non-zero status, or zero if no command exited with a non-zero status

Spring Boot Snippets

Mon, 01 Mar 2010 00:00:00 +0100

Define and Configure Log Groups

This allows to configure a group of loggers at the same time

Define a log group named myaspect with two packages
application.properties
```
logging.group.myaspect=com.hascode.package1,com.hascode.package2
```
Configure the log group and set all loggers to level TRACE
application.properties
```
logging.level.myaspect=TRACE
```

This is also possible as parameter on startup

java -Dlogging.level.myaspect=TRACE myapp.jar

Use JUnit 5 with Spring Boot

Use newer versions of Surefire and Failsafe plugins:

<properties>
[..]
  <maven-failsafe-plugin.version>2.22.0</maven-failsafe-plugin.version>
  <maven-surefire-plugin.version>2.22.0</maven-surefire-plugin.version>
</properties>