Hi Sumedha, a good first iteration. I would like to learn more about:
How the API mock back-end is created How does the system generate a mock API response how does the API creator configure a different API response per API parameter? What are the steps involved to turn a mock API into a real back-end API? I am unclear whether the Endpoint field presented in API Design Screen(1).png points to a back-end server where the API Back-end endpoint is instantiated. Are we instantiating mock API implementations on back-end hosts, or creating a loop-back in the API gateway? How does the user define a valid mock response? The "Options" note on API Design Screen(1).png is unclear. I understand APIM will rely on Script mediator and Payload factory, but the UI is not clear on how to configure these primitives. When using the script mediator, will the API creator have to craft JS that will process the request and return a mock response? will we provide a simple 'echo' mock? What meta-data could be injected into the mock API implementation to assist back-end development? For example, a JS comment providing information on the context and parameters would be helpful. When creating APIs, Can we inject resource representations and identifiers into the API response definition? For example, a call to API #1 referencing resource #1 will return Resource representation #1 and a resource identifier #2 (configurable by BE processing rules). > Message: 3 > Date: Fri, 2 May 2014 13:42:45 +0530 > From: Sumedha Rubasinghe <[email protected]> > To: "[email protected]" <[email protected]> > Subject: [Architecture] Proposal : Improving API Design capabilities > in API Manager > Message-ID: > <CAFiRN_qoh9xX+OyuV7ZULRi_2EbETD58= > [email protected]> > Content-Type: text/plain; charset="utf-8" > > Few of us (NuwanD, Jo, Lakmali, Sanjiva) had a discussion on $subject. > > We are thinking of expanding more API Design capabilities in API Manager. > In order to support this, we thought of supporting creating an API with > mock implementation. > > Current API flow can be summarized as follows: > > > ? > Image : > > https://docs.google.com/a/wso2.com/drawings/d/1ORpF-WF3bqNREoQys3AXn8yEAmsmHmH48CTtyDGgtSw/edit > > Proposed flow (bellow) will have some additional steps included to support > API design process. Steps 'Design' & 'Implement' will allow API Developers > to quickly come up with an API and mock implementation (refer notes). > > Two additional steps ('Generate Tests' & 'Monitor') have been added after > API gets deployed (refer notes). > > We already have an underlying language for defining an API. Plan is to > utilize that (+ current Swagger support for API description) for first > round of implementation. If there is a demand for other API design > languages, we will consider them @ a later stage. > > > ? > Image : > > https://docs.google.com/a/wso2.com/drawings/d/1M1u2hcYyjVXilCIMS8SlS5f-gUZBQwj1XMJ9Iw9zed8/edit > > New API Design Screen looks like following. It's a minimalistic version of > existing API Publisher view. (See my note on #3 above to understand how > this connects to existing publisher) > > There will be few more UIs (3) to support different API Source types. We > are planning to utilize underlying Java Script, Payload Factory & endpoint > mediation capabilities for this implementation. > > Image : > > https://docs.google.com/a/wso2.com/drawings/d/1gUyDL69EGkWH-Ifv5Rn8MXIZGacU6ADW5MOTpB_YVWU/edit > > > ? > > > -- > /sumedha > b : bit.ly/sumedha > -------------- next part -------------- > An HTML attachment was scrubbed... > URL: < > http://mail.wso2.org/pipermail/architecture/attachments/20140502/91d5c2aa/attachment.html > > > -------------- next part -------------- > A non-text attachment was scrubbed... > Name: API Design Screen(1).png > Type: image/png > Size: 29341 bytes > Desc: not available > URL: < > http://mail.wso2.org/pipermail/architecture/attachments/20140502/91d5c2aa/attachment.png > > > -------------- next part -------------- > A non-text attachment was scrubbed... > Name: Create-APIs.png > Type: image/png > Size: 54219 bytes > Desc: not available > URL: < > http://mail.wso2.org/pipermail/architecture/attachments/20140502/91d5c2aa/attachment-0001.png > > > -------------- next part -------------- > A non-text attachment was scrubbed... > Name: Design-APIs.png > Type: image/png > Size: 93954 bytes > Desc: not available > URL: < > http://mail.wso2.org/pipermail/architecture/attachments/20140502/91d5c2aa/attachment-0002.png > > > > ------------------------------ >
_______________________________________________ Architecture mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
