Skip to Main Content
Feature Request FR-1969
Product Area Application Builder
Status CLOSED

1 Voters

REST API: upgrade Generate Swagger Doc

ino.laurensse Public · Sep 17 2021

Idea Summary
Generate Swagger Doc currently generates Swagger 2.0 documentation. Allow the generation of OpenAPI v3. documentation too.

For more complex Json body input: add an option where the Json schema can be specified. This can then be added to the OpenAPI v3 documentation (instead of just PAYLOAD body of type String).

The same for Json output.

Use Case
The REST definition contains the full specification of Json input and output body.

You don't have to edit the generated code.

It makes it easier for REST consumers to generate code based on OpenAPI v3.

We reviewed this idea carefully and came to the conclusion that it does not constitute an appropriate APEX feature request.

Comments

Comments

  • carsten.czarski APEX Team OP 3.1 years ago

    APEX REST Workshop is only the UI for maintaining REST Services. ORDS is the engine which is responsible for executing REST APIs and also for Swagger generation. 

    Thus I'm closing this idea, as APEX is not the right product for this enhancement. You might raise the idea on the ORDS discussion forum:

    https://community.oracle.com/tech/developers/categories/oracle_rest_data_services

    regards

    -Carsten