louisthomaspro / api-doc-template

Developer documentation template for an API

API Title

This project is available on API-Portal

1. About

Short description of the project..

• Purpose of the API
• Languages, frameworks, libraries...

2. Getting Started

2.1 Prerequisite

• Librairies, softwares to install.

Ex : Oracle JDK 1.8+, Maven 3.2+ (used for projects build, dependency and documentation), Eclipse IDE or VScode, Spring Tools plugin : set of tools for Spring Boot (optional), Docker and docker-compose …

2.2 Installation

• Clone project, files configuration, IDE configuration…

2.3 Setup environment

• Config file (local, preprod & prod)
• Database configuration & restore data

2.4 Run & Build

• How to run the project (console commands, docker-compose…)
• Commands lines to build the project

2.5 Usage

• Integration postman run button :
• Local swagger URL : http://localhost/swaggerui/

Wiki

Find more in the Wiki