Is apigee EDGE is in sync with Dev Portal?

Not applicable

We created some API proxies in edge. We published those proxies in dev portal using WADL file. If i do any changes in proxy at edge, will that change get reflected in dev portal?

Solved Solved
0 2 298
1 ACCEPTED SOLUTION

@suresh ,

Short Answer, No, It won't be reflected automatically.

A Proxy - Is an entity which has some business logic of API - Like Mediation / Security / Transformation etc

A Smartdoc - API Documentation - Is an entity which holds Full API Information like endpoint / resources etc which is available in proxy as well as runtime information like request / response metadata which might not be present in API Proxy.

It's a tricky problem which can be solved to some extent but not full. Let's say

  • You have a backend API & you have created an API Proxy in Apigee Edge
  • Your API accepts query param like ?foo=bar , which is not mentioned anywhere in proxy but still your API accepts same. So, Apigee doesn't know about "foo" query param until unless you mention somewhere in proxy / captured runtime in Analytics
  • So, If we automatically generate Smartdocs then we need to talk to both analytics & apigee edge.
  • Even if we do so, we will capture only some part of your API, let's say user never called API with foo query param then we (Apigee) never know about that query param. So, it's not easyone to solve.

So, As of today, you need to manually update your WADL & re-publish smartdocs.

Apigee Smartdocs model & API Proxy is not connected at all. They are two different things. So, Sync is not applicable. Ideally, you can say , you have the proxy, you have the runtime information why don't you generate smartdocs? Great Question, Hope someday we will be there 🙂

View solution in original post

2 REPLIES 2

@suresh ,

Short Answer, No, It won't be reflected automatically.

A Proxy - Is an entity which has some business logic of API - Like Mediation / Security / Transformation etc

A Smartdoc - API Documentation - Is an entity which holds Full API Information like endpoint / resources etc which is available in proxy as well as runtime information like request / response metadata which might not be present in API Proxy.

It's a tricky problem which can be solved to some extent but not full. Let's say

  • You have a backend API & you have created an API Proxy in Apigee Edge
  • Your API accepts query param like ?foo=bar , which is not mentioned anywhere in proxy but still your API accepts same. So, Apigee doesn't know about "foo" query param until unless you mention somewhere in proxy / captured runtime in Analytics
  • So, If we automatically generate Smartdocs then we need to talk to both analytics & apigee edge.
  • Even if we do so, we will capture only some part of your API, let's say user never called API with foo query param then we (Apigee) never know about that query param. So, it's not easyone to solve.

So, As of today, you need to manually update your WADL & re-publish smartdocs.

Apigee Smartdocs model & API Proxy is not connected at all. They are two different things. So, Sync is not applicable. Ideally, you can say , you have the proxy, you have the runtime information why don't you generate smartdocs? Great Question, Hope someday we will be there 🙂

Thanks for your response. I hope that day come soon.