jpandres/docu-user-service

documented user service with spring restdocs

docu-user-service

Table of Contents

• Overview
• APIs
• Development setup
• CI
• Documentation
• Support
• Reference

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+ sdkman.io (recommended)

• 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: Asciidoctor Manual

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