Summary

Adding basic functionality to support the definition of vendor extensions on a per-path basis as requested in issue #1957. This would be defined by a developer within a swagger:route block of their codebase, and the corresponding swagger definition would be created when running swagger generate spec. These changes currently only support go1.11+.

These changes are making the following assumptions:

• the value of a vendor extension can be a single string, a list/array of strings, or objects
• a list cannot contain a mix of strings and objects
• annotations defining extensions should be indented properly
• each extension key must start with x-, e.g. x-some-extension
• objects defined in an extension may contain multiple other nested objects

The new extension parser reads through the Extension annotation block within a swagger:route annotation, checking for what kind of data each line may be and builds out as many map[string]interface{}s as necessary until reaching the end of the block.

• Simple key:value extensions will be map[string]string
• Lists/Arrays will be map[string]*[]string
• Objects will be map[string]interface{} that can contain any of the above types, including more objects

Example

Input:

// swagger:route GET /pets pets users listPets
//
// Lists pets filtered by some parameters.
//
//     Extensions:
//       x-example-flag: true
//       x-some-expected-list:
//         - dog
//         - cat
//         - bird
//       x-env-data:
//         userId:
//           prod: some-user-id
//           dev: some-test-id

Output:

paths:
  "/pets":
    get:
      operationId: listPets
      summary: Lists pets filtered by some parameters.
      tags:
      - pets
      - users
      extensions:
        x-example-flag: true
        x-some-list:
        - dog
        - cat
        - bird
        x-env-data:
          userId:
            prod: some-user-id
            dev: some-test-id

Fixes #1957