New post
Question
· Aug 6, 2019

API documantation on Postman

#API #Ensemble

Good Afternoon,

I'm working on a API documentation that wil be interactive, it's based on a BS class on Ensemble.

The objective on making the documentation is simplify the undestanding of the operation for those who are not acquainted with the Ensemble environment.

My problem is, when using Postman to test a operation the indentation appears as such:

{
    "authKey": "<string>",
    "authKeyType": "<string>",
    "birthDate": "<string>",
    "name": "<string>",
    "nameMother": "<string>",
    "zipCode": "<string>",
    "phone": "<string>",
    "token": "<string>",
    "senhaOrigem": "<string>",
    "origem": "<string>"
}

Wich produce the following error:

<BODY>
    <error>
        <source>Class.Name.BS.Example.yyy.xxx</source>
        <text>ERROR #6301: SAX XML Parser Error: invalid character 0x1 while processing Anonymous Stream at line 3 offset 120</text>
    </error>
</BODY>

The documentation works ok when the request is send in this format:

{"authKey": "<string>", "authKeyType": "<string>",  "birthDate": "<string>", "name": "<string>", "nameMother": "<string>",  "zipCode": "<string>",  "phone": "<string>",  "token": "<string>",  "senhaOrigem": "<string>", "origem": "<string>"}

My question is how can I configure the documentation in a way that it doesn't require the change in indentation to be manually made?

 

Ps: English is not my first language but i tried my best to write it correctly, I apologize for possible mistakes that may have been made.

Discussion (4)0
Log in or sign up to continue