Upgrade to OpenAPI 3.0

Question

Upgrade to OpenAPI 3.0

8

Several advantages of using OpenAPI 3.0 over 2.0 (Swagger):

url templating
multiple content-types
multiple flows per oAuth2 scheme

Also see this newstuff-overview:

Simplified structure, with increased reusability
Operations can now consume both formdata and other media types such as JSON.
The consumes array is replaced with the requestBody.content map which maps the media types to their schemas.
Schemas can vary by media type.
Form data can now contain objects, and you can specify the serialization strategy for objects and arrays.

Export a published REST-service of your Mendix application to see the current export: Swagger 2.0.

Love this feature.Would love it even more if it generates OpenAPI 3.0

asked 2019-07-02

Tim v Steenbergen

4 answers

Joost Verhoog · Answer 1 · 2023-07-24

Studio Pro 10.1.0, which will be released soon, will publish the OpenAPI 3.0 for REST services.

Hari sanker B · Answer 2 · 2023-07-22

@Tim I am looking for any workaround solution for this

Tim v Steenbergen · Answer 3 · 2019-07-09

@Ronald, the releasenote indicates that the SwaggerUI is upgraded and compatible with OpenAPI 3.0. But it does not mention the swagger.json-export getting the new OpenAPI 3.0 definition. It does however make it more feasible.

Ronald Catersels · Answer 4 · 2019-07-08

I might be mistaken but it seems Mx8 already generates OpenAPI3.0. See the upcoming release notes here: https://github.com/mendix/docs/pull/1788/files

* We upgraded Swagger UI (used in the interactive documentation of published REST services) from 3.4.3 to 3.22.2.

And according to https://github.com/swagger-api/swagger-ui

Compatibility

The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:

Swagger UI VersionRelease DateOpenAPI Spec compatibilityNotes3.18.32018-08-032.0, 3.0tag v3.18.3

Regards,

Ronald