What was used for Swagger?

Swagger is a set of tools for describing, documenting, and testing REST APIs.

What is usually used with Swagger:

• OpenAPI Specification (formerly Swagger Specification) — a standard for describing APIs in YAML or JSON format.
• Swagger Editor — a web tool for writing and editing OpenAPI specifications.
• Swagger UI — automatically generated interactive API documentation that allows testing requests directly from the browser.
• Swagger Codegen — generating client SDKs and server stubs based on the specification.

Using Swagger allows:

• Clearly describing the API structure.
• Providing a single source of truth for developers.
• Simplifying integration and testing.

An example of a simple GET request description in OpenAPI:

paths:
  /orders:
    get:
      summary: Get a list of orders
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'