Close

Azure Web App Contract-First

My job was actually to create an OpenAPI definition for the service (aka Swagger file) and create a stub service to have a testable endpoint on short notice. Maybe it’s not entirely correct to talk about contract-first, but hoepfully it will guide you in the right direction.

Document REST service with Mermaid

For documentation of a REST service you can use a Javascript library called Mermaid (https://mermaidjs.github.io/). From the GitHub page, Mermaid is recommended as follows: Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code? This is why mermaid was born, a simple markdown-like script language for generating charts from text…

Swagger documentation for Java REST service

If you want the Swagger definition of a .Net WebAPI (or REST service), you can go to: http://host/courseresults/swagger for tyhe Swagger page. http://host/courseresults/swagger/docs/v1 for the Swagger document I didn’t know how to get the same Swagger documentation for a Java REST service. I don’t know if there’s a standard way, but this is how I…