Creating SmartDocs from OpenAPI Spec; how to do it most efficiently?

Not applicable

Hi, i am new to apigee and have created a proxy from our backend service YAML and now trying to generate the SmartDocs for the proxy service. How can I do it efficiently as proxy has many service endpoints other than manually porting.

Solved Solved
1 3 460
1 ACCEPTED SOLUTION

Hi, @TomfransDavis welcome to Apigee!

If you haven't checked out the online SmartDocs documentation, please do.

SmartDocs pages are generated from Open API Specification (f.k.a. Swagger) in either YAML or JSON in the Developer Portal (a.k.a. Developer Services portal) which is separate from Apigee Edge.

If you created your API proxy using "Use OpenAPI" spec in Edge then you should be able to import that into the Dev Portal. Don't forget to change the host and basepath values.

If, however, your backend YAML is something completely different and you created your proxy by hand and want to generate and OpenAPI spec from it or any other proxy, then see these community articles:

https://community.apigee.com/articles/15397/api2swagger-open-api-swagger-20-spec-generator-fro.html

https://community.apigee.com/articles/25770/openapi-spec-swagger-spec-generator-a-tool-to-gene.html

And this article which generates a skeleton OpenAPI spec.

https://community.apigee.com/articles/10044/apigee2openapi-a-nodejs-command-line-tool-to-gener.html

View solution in original post

3 REPLIES 3

Hi, @TomfransDavis welcome to Apigee!

If you haven't checked out the online SmartDocs documentation, please do.

SmartDocs pages are generated from Open API Specification (f.k.a. Swagger) in either YAML or JSON in the Developer Portal (a.k.a. Developer Services portal) which is separate from Apigee Edge.

If you created your API proxy using "Use OpenAPI" spec in Edge then you should be able to import that into the Dev Portal. Don't forget to change the host and basepath values.

If, however, your backend YAML is something completely different and you created your proxy by hand and want to generate and OpenAPI spec from it or any other proxy, then see these community articles:

https://community.apigee.com/articles/15397/api2swagger-open-api-swagger-20-spec-generator-fro.html

https://community.apigee.com/articles/25770/openapi-spec-swagger-spec-generator-a-tool-to-gene.html

And this article which generates a skeleton OpenAPI spec.

https://community.apigee.com/articles/10044/apigee2openapi-a-nodejs-command-line-tool-to-gener.html

Thank you @Kurt Kanaskie first option worked for me.

@TomfransDavis, Welcome to Apigee Community 🙂

Did you check our labs project http://specgen.apistudio.io/ which is UI version of api2swagger & helps you collaborate on cloud ?

Keep us posted.