Swagger

Contactar con el profesor

Sirve para ver más visualmente end points de la API.

npm i swagger-jsdoc
npm i swagger-ui-express

Documentación: https://swagger.io/docs/specification/

swagger.yml

paths:
  /:
    get:
      description: Test request
      tags:
        - Public
      responses:
        200:
          description: Ok

  /restricted-path:
    get:
      description: Restricted path
      tags:
        - Restricted
      responses:
        200:
          description: Ok

  /login:
    post:
      description: Login endpoint
      requestBody:
        description: User credentials (email, password)
        content:
          application/json:
            examples:
              Credentials exmaple:
                value:
                  mail: pp@pp.com
                  pass: pp
            schema:
              type: object
              properties:
                mail:
                  type: string
                pass:
                  type: string
      tags:
        - Public
      responses:
        200:
          description: Ok

Además, nos permite probar nuestros métodos sin necesidad de programar un front:

Swagger 1

Tras pulsar el botón, el siguiente cuadro será editable:

Swagger 2
← NodeJS template
Swagger →

Aviso Legal | Política de privacidad