recursive model definitions causes crash

[matssk]

If you have a model with a self reference, the code generator crashes:

definitions:
  pet:
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
      tag:
        type: string
      children:
        type: array
        items: 
          $ref: '#/definitions/pet'

[wing328]

Are you suggesting it should throw an exception with a proper error message instead ?

[matssk]

I'm suggesting it could generate valid code instead. It is not impossible, in my manually implemented client library I have some code like this.

[wing328]

For the client library you mentioned, may I know what programming language did you use ? I'm not sure if all programming languages support circular references.

[matssk]

C# and Java. Both have no problems with something like this

public class Pet {
   private Pet pet;
}

[wing328]

For the models with circular reference, does it work in swagger-ui? Just want to know if other swagger tools already support models with circular reference.

[matssk]

Yes, and the swagger-editor added support for it a couple months ago.

[fehguy]

I thought this was fixed, but I believe it's simple to do in XmlExampleGenerator.java

[webron]

Fixed in develop_2.0.

[JohnGalt1717]

The better solution is that the UIs and processors need to handle this properly instead of endlessly looping.

[wing328]

@JohnGalt1717 are you referring to swagger-ui?

[JohnGalt1717]

Yes, among others. The problem is there code that doesn't cache entries and just link it back up again instead of just following the path blindly. (And their latest code as the same issue)

[wing328]

Ok. Please open the issue in https://github.com/swagger-api/swagger-ui instead.

[JohnGalt1717]

Already done. But I was just making a point that this isn't really an issue here, it's a UI and parsing issue on the other side.