Swagger: map of

by

Using additionalPropertiesis the proper way to describe hashmap with OpenAPI (fka. Swagger) Specification but Swagger UI do not render them for now.

The issue is tracked here https://github.com/swagger-api/swagger-ui/issues/1248

Meanwhile you can use this trick: define a non required property (defaultin the example below) of the same type of the map’s objects and give some hint within the description:

swagger: "2.0"
info:
  version: 1.0.0
  title: Hashmap
  
paths: {}

definitions:
  MapItem:
    properties:
      firstname:
        type: string
      lastname:
        type: string
  Map:
    description: a (key, MapItem) map. `default`is an example key
    properties:
      default:
        $ref: '#/definitions/MapItem'
    additionalProperties:
      $ref: '#/definitions/MapItem'

This description does not modify API contract and improves documentation.

More Related Contents:

  1. Swagger HashMap property type
  2. Why `additionalProperties` is the way to represent Dictionary/Map in Swagger/OpenAPI 2.0
  3. Where can I find this Mappr Maps? [closed]
  4. How do you add a Dictionary of items into another Dictionary
  5. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  6. How to check if a map contains a key in Go?
  7. How to initialize a dict with keys from a list and empty value in Python?
  8. How to document dynamic query parameter names in OpenAPI (Swagger)?
  9. How to get memory size of variable in Go?
  10. How to add multiple example values in swagger properties?
  11. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  12. How to access deeply nested dictionaries in Swift
  13. How to convert OpenAPI 2.0 to OpenAPI 3.0? [closed]
  14. How do I include subclasses in Swagger API documentation/ OpenAPI specification using Swashbuckle?
  15. Post a json body with swagger
  16. How to define an optional parameter in path using swagger
  17. Swagger: “equivalent path already exists” despite different parameters
  18. Iterating Through a Dictionary in Swift
  19. OpenAPI query string parameter with list of objects
  20. How to add multiple example values for an array in OpenAPI/Swagger?
  21. OpenAPI path/query parameters nested structure serialization
  22. Map with concurrent access
  23. Sending cookie session id with Swagger 3.0
  24. Schema object without a type attribute in Swagger 2.0
  25. What is the difference between a map and a dictionary?
  26. Where to find dictionaries for other languages for IntelliJ?
  27. In Swift can I use a tuple as the key in a dictionary?
  28. Copying all elements of a map into another
  29. Swift NSUserDefaults not saving Dictionary?
  30. How to recover from concurrent map writes?

Leave a Comment