API docs with swagger

📋 Introduction

Swagger set of tools for designing, building, documenting, and using RESTful web services. Check his strength in Swagger I/O.

☁️ Getting Started

Follow along this notes. You can use some package management tool for windows. E.g. Chocolatey

For a local deploy

You will need to have at least Java 8 installed or some openJDK distribution, and Gradle on the PATH.

• OpenJDK8 Zulu - Java Development Kits (OpenJDK build)

choco install zulu8 -y

• Gradle - Constructor and manager dependencies

choco install gradle --version 5.6.4 -y

For a docker deploy

• Docker Desktop - Application virtualizer for windows

choco install docker-desktop -y

NOTE: Register in Docker Hub to be able to use the docker registry

To know the API documentation technique.

💻 Commands to execute

For a local execution

gradle build
gradle bootRun

And access in local-swagger-ui

For a docker execution

docker-compose up -d --build

And access in docker-swagger-ui

Can you support me?

I will continue to do things and expose notes, but existing many ways to support what I do:

• Pull requests are welcome a 💫
• Don't forget to give this Repository a 🌟
•