Swagger for dummies

I am using WEB handler (not REST)

Hi

We are using https://editor.swagger.io/ in order to write (manually) our swagger. Very handy.

In fact we do everything manually, no json generation (we are using the REST adapter and in order to circumvent its limitations, webhandlers through URL Rewrite so that they have consistent URI with those from the REST adapter).

You're right to start with Web handlers; had I known the limitations of the REST adapter I'd do the same a few years ago.

Regards

JC

Hello,

Are you working with Business Entities and generating a catalog file for the Progress Data Service?

If so, you might be interested on a sample program to generate an OpenAPI spec file (formerly known as Swagger) from a catalog file:

- community.progress.com/.../3389

If you are not working with a catalog file, perhaps, we should express our interest on creating an OpenAPI spec for REST/WebHandlers so that Product Management knows that developers are interested.

I hope this helps,

Edsel

Thanx Jean-Christophe :-) I will check it out..

Update from Progress Community <4U1JQ3CSXXVK-png_2D00_70x70x2-png> Jean-Christophe Cardot Hi We are using https://editor.swagger.io/ in order to write (manually) our swagger. Very handy. In fact we do everything manually, no json generation (we are using the REST adapter and in order to circumvent its limitations, webhandlers through URL Rewrite so that they have consistent URI with those from the REST adapter). You're right to start with Web handlers; had I known the limitations of the REST adapter I'd do the same a few years ago. Regards JC View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse.

We are not using BE.

Probably, but I feel more free without :-) 

<ProgressEmailLogo-png_2D00_150x42x2-png> Update from Progress Community <4U6EDACHGGRD-jpg_2D00_70x70x2-jpg> Mike Fechner You should ;-) Sent from Nine Von: goo <bounce-goo@community.progress.com> Gesendet: Mittwoch, 18. September 2019 19:38 An: TU.OE.General@community.progress.com Betreff: RE: [Technical Users - OE General] Swagger for dummies Update from Progress Community goo We are not using BE. Geir Otto Sendt fra min iPad 18. sep. 2019 kl. 14:40 skrev egarcia <bounce-egarcia@community.progress.com>: Update from Progress Community egarcia Hello, Are you working with Business Entities and generating a catalog file for the Progress Data Service? If so, you might be interested on a sample program to generate an OpenAPI spec file (formerly known as Swagger) from a catalog file: - community.progress.com/.../3389 If you are not working with a catalog file, perhaps, we should express our interest on creating an OpenAPI spec for REST/WebHandlers so that Product Management knows that developers are interested. I hope this helps, Edsel View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse. View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse. View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse.

Well, the last time I checked the BE delivered in OE turned out to be more of a Service Interface (SI) instead of a proper BE. This BE (or should I say SI) is nice for demo's but not the way to go for a complete application since it basically combines handling of two things: the transport protocol (http) and business logic.

You're not talking about SmartComponent Library accidentally, do you? :-D

I surfed a bit on net and found that I would need to download swagger to a local webserver, and refer to that...

Would it be possible to add the swagger to PASOE webserver? ie. put it in /static area?

I surfed a bit on net and found that I would need to download swagger to a local webserver, and refer to that...

Would it be possible to add the swagger to PASOE webserver? ie. put it in /static area?

The Swagger UI is already part of the PASOE server . There's some doc on getting it enabled (docs.progress.com/.../Enable-Swagger-UI-for-management-REST-API-access.html) , and more info if you search for "swagger' in the doc.

The more important part is the where the API data comes from - the oemanager API that's provided does not use a YAMl or JSON file. I've had success generating an OpenAPI doc from our Data Object Handler's services and loading that JSON into the swagger UI.

If you're feeling up to it, the OpenAPI spec for the file is at https://swagger.io/specification/ .

No, only Expose it so others can read it/use it

Update from Progress Community Peter Judge When you say "export swagger file into PASOE" do you mean "create services in PASOE"?   View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse.

Ok, but what else is needed? Will pasoe understand that it is swagger and formate the json fire? Or do I need to add additional files to the same area?

Update from Progress Community <4U6EDACHGGRD-jpg_2D00_70x70x2-jpg> Mike Fechner So you want to host the Swagger file (you manually created) on PASOE?   Just copy it to the static folder of your webapp. View online   You received this notification because you subscribed to the forum.  To unsubscribe from only this thread, go here. Flag this post as spam/abuse.

Swagger UI and the API are available by default for you with oemanager. Once you have the SwaggerUI, all you have to do is add your OpenAPI URL in the search box and it will parse and show the data for you in Swagger UI.

Swagger UI and the API are available by default for you with oemanager. Once you have the SwaggerUI, all you have to do is add your OpenAPI URL in the search box and it will parse and show the data for you in Swagger UI.