¿Qué es Swagger?

Es un estandar de definición de API

Es totalmente independiente del lenguaje sobre el que este creada la API

Pero he mentido un poco...

Si hablamos de forma técnica, Swagger es...

una especificación formal rodeada de un ecosistema de herramientas

¿Para que sirve?

Permite comprender todos los puntos de entrada sin ni siquiera ver el código fuente.

Por tanto, se evitan problemas con los consumidores, ya que de un simple vistazo pueden conocer toda la API

Y así es como se vería

swagger: '2.0'
info:
  version: 1.0.0
  title: Echo
  description: |
    #### Echos back every URL, method, parameter and header
    Feel free to make a path or an operation and use Try Operation to test it. The echo server will
    render back everything.
schemes:
  - http
host: mazimi-prod.apigee.net
basePath: /echo
paths:
  /:
    get:
      responses:
        200:
          description: Echo GET
    post:
      responses:
        200:
          description: Echo POST
      parameters:
        - name: name
          in: formData
          description: name
          type: string
        - name: year
          in: formData
          description: year
          type: string
  /test-path/{id}:
    parameters:
      - name: id
        in: path
        description: ID
        type: string
        required: true
    get:
      responses:
        200:
          description: Echo test-path
    

Facilidad a la hora de editar

Este YAML se puede editar y utilizar para crear tanto servidor como cliente (en varios lenguajes) a través de la herramienta online

¡ADEMÁS SE PUEDE VER EN TIEMPO REAL LOS CAMBIOS!

Además

La versión la especificación de SWAGGER...

No es lo que queremos

Esto simplemente genera código para posteriormente trabajar

Nuestras APIs son cambiantes y esto no sirve

Es por ello que hay que trucar "un poquito" su funcionamiento

Y aquí es donde molamos

La idea es mejorar como funciona para regenerar código cada vez que queramos

Es por ello que vamos a ver como se hace, mediante código la...