Swagger Doc for ORDS RESTful Services

thatjeffsmith ORDS 4 Comments

Tell Others About This Story:

We’ve just released version 17.3 of Oracle REST Data Services – as an Early Adopter (BETA).

Go Download ORDS 17.3 Now.

There are 2 major new features, and this post is about one of those: Swagger/OpenAPI style JSON for /metadata_catalog/ calls.

Wait, why should I care about REST?

The Movie

Screenshots for Those that Can’t do YouTube at Work

It’s fairly simple. Navigate to the /metadata-catalog/ URI for your RESTful Service.

We don’t generate this for the Schema level catalog call – just on the actual service meta call.

Then copy this {…JSON…} over to something like Swagger.IO.

Once you paste it, say ‘Cancel’ on the popup dialog if you don’t want the JSON convereted to YAML – it’s up to you really.

Then start using the Swagger page.

Pretty!

But this isn’t just for looks – it’s also a REST Client!

Fill out your POST Body JSON stuff, hit Execute, and see what happens 🙂

Also note it happily gives you a CURL command you can use too!

Whiz-bang.

Why Should I Care about REST?

I’m so happy you asked.

Go read this post in the current issue of UKOUG Scene.

Why would a DB person care about REST?

Tell Others About This Story:

Comments 4

  1. Hi Jeff, This is cool, but is there a way I can generate swagger spec for all of the REST API definitions that I created using my procs and functions in SQL Dev using ORDS?

    Thanks,
    Poorni

    1. thatjeffsmith Post
      Author
      1. By how I mean – The /metadata-catalog and /open-api-catalog are coming up for my REST enabled tables. But for the REST modules, these URLs are giving me a 404 error!

Leave a Reply

Your email address will not be published. Required fields are marked *