Get hands-on experience with 20+ free Google Cloud products and $300 in free credit for new customers.

Can Smartdocs be created from a Swagger 2 document?

Not applicable

I see that smartdocs supports importing Swagger but I did not see anywhere what version of Swagger it supports. I also saw other references to it supporting only the 1.2 and 2.0 was on the way.

I have a few questions:

  • Does smartdocs support importing Swagger 2.0 yet?
  • If not, any idea when support for Swagger 2.0 will be added?
  • if it is not currently supported, what should i do in the meantime? Is there a way to manually enter info for a SmartDoc while waiting for 2.0 support?
  • When importing WADL or SmartDocs JSON you have the option to use a file or a url, why is the file option not offered when importing a swagger document? It would be easier.
  • When importing a swagger doc, what format does the document need to be in? Can it be YAML ir does it have to be JSON?
  • I am using a127 and have deployed an API to Apigee Edge, is there a way to get a URL from the deployed API on Apigee to the swagger doc?

Thanks!

...Ed

Solved Solved
4 23 4,057
2 ACCEPTED SOLUTIONS

Hi @Ed McPadden. SmartDocs was released before there was a Swagger 2, so it sounds like we may have some documentation we should clean up. Thanks for pointing out that confusion.

We depend on the swagger-codegen project, which only hit M1 in the last couple of weeks. Our development branch has now incorporated this (though it is still a pre-release candidate), so 2.0 import should land within the next few releases, assuming all goes well. It is likely that you'll be able to import YAML or JSON, since they are so interchangeable. Note that 1.x only supported JSON.

Swagger 1.x was a distributed file format, so it requires multiple files. Swagger 1.x convention also expected the descriptions to live alongside the APIs, so importing by URL was the logical approach. Swagger 2 is much more flexible about this, which is great.

HTH,

Marsh

View solution in original post

Dear @Ed McPadden & @Vineet Bhatia ,

We now have Swagger 2.0 support for Apigee Developer Portal SmartDocs. For more details please refer here.

Cheers,

Anil Sagar

View solution in original post

23 REPLIES 23
Top Solution Authors