Skip to content

1) XML Input

Thomas Lapierre edited this page Jun 3, 2021 · 10 revisions

XML Input

As mentioned several times, this module takes as a parameter an XML file that it will then convert into OpenAPI 2.0 JSON documentation.

This XML file must have a very specific structure with some mandatory and some optional tags that I will present.

Summary

Global structure

Objects definition

Rest definition

Global structure

Field Name Type Required Description
<objects> [Object] false List of objects definition
<rest> Rest object true Detailled webserver informations

Structure

<?xml version="1.0" encoding="utf-8"?>    
<global>
    <objects>
	...
    </objects>
    <rest>
	...
    </rest>
</global>

Data type

Data type
integer
long
float
double
string
byte
binary
boolean
date
dateTime
password
array

Java structure

Clone this wiki locally