README.adoc

= docu-user-service jpandres; :doctype: book :icons: font :source-highlighter: highlightjs :toc: left :toclevels: 3 :sectlinks:

image::https://github.com/jpandres/docu-user-service/workflows/Gradle%20build%20and%20deploy%20to%20heroku/badge.svg[link="https://github.com/jpandres/docu-user-service/actions?query=workflow%3A%22Gradle+build+and+deploy+to+heroku%22"] image::https://codecov.io/gh/jpandres/docu-user-service/branch/main/graph/badge.svg[link="https://codecov.io/gh/jpandres/docu-user-service"] == Overview This is a sample API with the Spring RestDocs to document it.

== APIs This project exposes the following APIs:

• /api/v1/users

== Development setup You'll need:

• git
• JDK 15+ link:https://sdkman.io/[sdkman.io] (recommended)
• link:https://www.jetbrains.com/idea/[Intellij]

== CI This app uses github actions to build the app and deploy it to heroku.

https://docu-user-service.herokuapp.com/

== Documentation

You can find 2 types of documentation:

• Open API : https://docu-user-service.herokuapp.com/swagger-ui.html
• Spring RestDocs https://docu-user-service.herokuapp.com/docs/api.html

== Support You can reach me @jpandres

== Reference

If you are not familiar with asciidoc please refer to the documentation: link:https://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]

sequenceDiagram Alice->>John: Hello John, how are you? John-->>Alice: Great!