Published 1/2023MP4 | Video: h264, 1280x720 | Audio: AAC, 44.1 KHzLanguage: English | Size: 424.44 MB | Duration: 0h 52m

Basic fundamentals for swagger, open api and restdocs with spring boot

What you'll learn

swagger , open api with spring boot

swagger , open api with spring boot

swagger , open api with spring boot

swagger , open api with spring boot

Requirements

java, spring boot

Description

Documentation is an essential part of building REST APIs. In this tutorial, we'll take a look at SpringDoc — a tool that simplifies the generation and maintenance of API docs based on the OpenAPI 3 specification for Spring Boot 1.x and 2.x applications.Besides generating the OpenAPI 3 specification itself, we can integrate springdoc-openapi with Swagger UI so that we can interact with our API specification and exercise the endpoints.The springdoc-openapi dependency already includes Swagger UI, so we're all set here.springdoc-openapi java library helps to automate the generation of API documentation using spring boot projects. springdoc-openapi works by examining an application at run to infer API semantics based on spring configurations, class structure and various annotations.Automatically generates documentation in JSON/YAML and HTML format APIs. This documentation can be completed by comments using swagger-api annotations.This library supports:OpenAPI 3Spring-boot (v1, v2 and v3)JSR-303, specifically for @NotNull, @Min, @Max, and @Size.Swagger-uiOAuth 2GraalVM native imagesDocumentation will be available in HTML format, using the official swagger-ui jarsThe Swagger UI page will then be available athttp://server:port/context-path/swagger-ui.html and the OpenAPI description will be available at the following url for json format:http://server:port/context-path/v3/api-docsserver: The server name or IPport: The server portcontext-path: The context path of the applicationDocumentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml

Overview

Section 1: Introduction

Lecture 1 Introduction

Section 2: swagger , open api with spring boot

Lecture 2 spring boot crud basic app

Lecture 3 spring boot swagger basic setup

Lecture 4 spring boot example with apiinfo

Lecture 5 spring boot example with openapi

Lecture 6 spring boot example with openapi contact info

Lecture 7 sprng boot exaple with multiple servers

Lecture 8 spring boot example with hidden annotation

Lecture 9 spring boot example with grouping api

Section 3: Restdocs with asciidoc

Lecture 10 Basic simple asciidoc examle

Lecture 11 Restocs with sample test case

Section 4: Thank you

Lecture 12 thank you

for bners who wants to learn basic open api with spring boot

HomePage: