YouTip LogoYouTip

Swagger Tutorial - OpenAPI Basics

Swagger

Swagger (OpenAPI) describes REST API interfaces.

openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/User"

Summary

  • OpenAPI/Swagger defines API contracts
  • Auto-generates documentation and client SDKs
← UniApp Tutorial - Getting StarPowerShell Tutorial - Getting β†’