Convert Property to an AttributeĪs we said above, by default, properties are transformed to child elements of the parent “object” element.

To change the default behavior, add the xml/name field to your spec:įor arrays, the xml/name property works only if another property – xml/wrapped – is set to true. Change Element Namesīy default, XML elements get the same names that fields in the API declaration have. You can use this object to transform some properties to attributes rather than elements, to change element names, to add namespaces and to control transformations of array items. The OpenAPI 3 format offers a special xml object to help you fine-tune representation of XML data. is represented in the following way in JSON and XML:Īs you can see, in XML representation, the object name serves as a parent element and properties are translated to child elements. For example, the following declaration - components: In your API specification, you can describe data in both XML and JSON formats as they are easily interchangeable.

Best xml editor first object