Salesforce

Swagger on PASOE: Does work with any .war REST services

« Go Back

Information

 
TitleSwagger on PASOE: Does work with any .war REST services
URL NameSwagger-on-PASOE-Does-work-with-any-war-REST-services
Article Number000112740
EnvironmentProduct: OpenEdge
Version: 11.7.4 and 12.x
OS: All supported platforms
Other: PAOSE, Swagger
Question/Problem Description
Is there any way to use Swagger with PASOE (REST Service) currently?
Is this considered for future release?


Steps to Reproduce
Clarifying Information
Using Swagger for own deployed REST Services and not only for the OEMANAGER.
Error Message
Defect Number
Enhancement Number
Cause
Resolution
In OpenEdge 11.7.4 the Swagger integration is only for the OEMANAGER, not for any deployed REST Services file. Progress support SwaggerUI for OEMANAGER by default, for an own Swagger file(JSON/YAML) it can be viewed with the same SwaggerUI, but might need some customizations. If the goal is to have the services of OEABL WebApplication deployed in PASOE can be accessed from Swagger then Progress OpenEdge does not have any such capability yet.

Although, this is in OpenEdge 12, the OpenAPI Specification (formerly known as the Swagger Specification) describes RESTful Web Services, the specification can be used to generate client and server programs as well as documenting the services.

The following idea, which can be voted for, has been logged to enable generating an OpenAPI spec file from a catalog file in PASOE:
https://openedge.ideas.aha.io/ideas/OPENEDGE-I-825

For more details about how to access/use Swagger UI please review the following information at Progress Hub:
Progress Information Hub -> Manage Progress Application Server (PAS) for OpenEdge - > Monitor PAS for OpenEdge instances -> Use Swagger UI to explore management REST APIs -> Enable Swagger UI for management REST API access:
https://docs.progress.com/bundle/pas-for-openedge-admin/page/Enable-Swagger-UI-for-management-REST-API-access.html

 
Workaround
Following community post contains a sample program to generate an OpenAPI spec file from a catalog file:
https://community.progress.com/s/question/0D54Q00007qckt1SAA/sample-program-to-generate-an-openapi-spec-file-from-a-catalog-file
Notes
References to Other Documentation:

Progress Article(s):

000093193, How to enable swagger for PASOE instance

Discussion on Swagger in the community archive:
https://community-archive.progress.com/forums/00026/59559.html
Keyword Phrase
Last Modified Date12/11/2020 5:39 PM

Powered by