====== Diseño de APIs: OpenAPI Specification ======

{{ openapi.png?400 }}

===== Enfoque API First =====

<figure>
{{ api-first.png }}
<caption>Enfoque API First [Fuente: https://softjourn.com/insights/5-benefits-of-api-first-design ]</caption></figure>

===== OpenAPI Specification =====

  * https://swagger.io/docs/specification/basic-structure/
  * https://swagger.io/docs/specification/describing-parameters/


<file yaml myapi.yaml>
    openapi: 3.0.0
    info:
      title: Sample API
      description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
      version: 0.1.9
    servers:
      - url: http://api.example.com/v1
        description: Optional server description, e.g. Main (production) server
      - url: http://staging-api.example.com
        description: Optional server description, e.g. Internal staging server for testing
    paths:
      /users:
        get:
          summary: Returns a list of users.
          description: Optional extended description in CommonMark or HTML.
          responses:
            '200':    # status code
              description: A JSON array of user names
              content:
                application/json:
                  schema: 
                    type: array
                    items: 
                      type: string
</file>

===== Generar el código: Swagger Codegen =====

----

(c) 2022-{{date>%Y}} Santiago Faci