Enhancing Swagger documentation and functionality

Question

Enhancing Swagger documentation and functionality

72

Hi,

when building published REST API’s the easiest way to test these should be via the Swagger that Mendix generates. Unfortunately, most of the times there is a reaon why we can’t use it, because the Mendix Swagger is too basic.

Is is possible for Mendix to enhance the swagger functionality?

This can be done by either:

Let developers upload a custom swagger.json file with total freedom via Studio Pro, or as a file in the project folder that will override the auto-generated swagger
Simply improve the automatically generated file
1. Add headers, for example for authorization
2. Add custom response codes, for example for error handling
3. I’m probably missing things now that the Mendix Swagger doesn’t cater for, please feel free to add improvements :-)

asked 2021-04-13

Jord ten Bulte

4 answers

Fabian Recktenwald · Answer 1 · 2024-01-12

Addition: show an example for mappings based on JSON (this only seems to work for mappings from a message definition)

Hari Sanker B · Answer 2 · 2023-09-11

I really love to get a feature to either put custom documentation , yml or json . The multiple sample example response are must to have.

Johan Flikweert · Answer 3 · 2023-01-27

Addition: Support for enumerations, such that consumers know the possible values of that string.

Peter Dorsman · Answer 4 · 2022-10-11

This would indeed be very handy.