Swagger Inheritance and Composition

by

As a beginner in swagger I don’t find the official documentation about polimorphism and composition easy to undestand, because it lacks an example. When I searched the net, there are lots of good examples refering to swagger 1.2 when extends was valid.

For swagger 2.0 I found a good example in swagger spec sources on github via this google group

Based on above sources, here is a short valid inheritance example in YAML:

definitions:
  Pet:
    discriminator: petType
    required:
      - name
      - petType # required for inheritance to work
    properties:
      name: 
        type: string
      petType:
        type: string
  Cat:
    allOf:
      - $ref: '#/definitions/Pet' # Cat has all properties of a Pet
      - properties: # extra properties only for cats
          huntingSkill:
            type: string
            default: lazy
            enum:
              - lazy
              - aggressive
  Dog:
    allOf:
      - $ref: '#/definitions/Pet' # Dog has all properties of a Pet
      - properties: # extra properties only for dogs
          packSize:
            description: The size of the pack the dog is from
            type: integer

More Related Contents:

  1. How to export swagger.json (or yaml)
  2. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  3. How to specify if a field is optional or required in OpenAPI/Swagger?
  4. How to return an array of objects in SwaggerHub?
  5. How to document dynamic query parameter names in OpenAPI (Swagger)?
  6. How to define a mixed-type array (with different element types) in OpenAPI 2.0?
  7. How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)
  8. How to define a property that can be string or null in OpenAPI (Swagger)?
  9. Swagger schema properties ignored when using $ref – why?
  10. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  11. Swagger 2.0: Multiple Path objects with different paths but same request and response
  12. Use object type query param in swagger documentation
  13. Swagger/OpenAPI – use $ref to pass a reusable defined parameter
  14. How to convert OpenAPI 2.0 to OpenAPI 3.0? [closed]
  15. Swagger: wildcard path parameters
  16. How to define an optional parameter in path using swagger
  17. Swagger API which is having query string
  18. Swagger: “equivalent path already exists” despite different parameters
  19. Re-using model with different required properties
  20. How to write OpenAPI 3 (Swagger) specification for property name in `map` object?
  21. How not to copy-paste 3 generic error responses in almost all paths?
  22. Combining defintions in Swagger docs
  23. How to define global parameters in OpenAPI?
  24. Schema object without a type attribute in Swagger 2.0
  25. Swagger: take one or more values from enum
  26. Swagger/OpenAPI mock server
  27. Swagger complex response model with dynamic key value hash maps
  28. Added Springfox Swagger-UI and it’s not working, what am I missing?
  29. Swagger UI passing authentication token to API call in header
  30. How to document default None/null in OpenAPI/Swagger using FastAPI?

Leave a Comment