ibm-apiconnect/apichol

API Connect Hands-On Labs

apichol's Issues

ex6 issues

Working on my mac.

Enter the uri credential into the url field and your database credential into the Database field.

I think it should be uri credential into url field and name credential into Database field. You can ignore the other fields.

Might be good to have brief description for atleast the id and index field?

Might be a good idea to be a bit more verbose and include screens that the model was saved (for troubleshooting perhaps).

ex6 issues

I try to create the mysql-db and when I try to install the connector, I get

Exercise 3 apic edit

To open the API Designer, on the command line enter:

apic edit

The Bluemix ID login just does not work for me.

Suggest using

SKIP_LOGIN=true apic edit

or can you help me fix the login via Bluemix?

Exercise4: cf create-service error

Hi,
When I issue the command below for the exercise 4 , I get "Server error, status code: 403, error code: 10003, message: You are not authorized to perform the requested action". How can I solve this issue? Thanks.

The command:
cf create-service cleardb cb5 workshopmysql

The Error:
Creating service instance workshopmysql in org MOCC / space dev as [email protected]...
FAILED
Server error, status code: 403, error code: 10003, message: You are not authorized to perform the requested action

Exercise: Received a Swagger JSON, so now what?

Help users learn how to import a Swagger JSON def file, publish the APIs represented by the file and then manage them.

• {Optional} Deploy a REST Server that generates a swagger def file
• Import Swagger File
• Create a plan and publish
• Test endpoints

Exercise: Deploy newly created APIs from local to Bluemix

Assume user has already created service on Bluemix

Create Bluemix target
Publish App and API
Navigate to Bluemix and monitor running app
Use API manager to make calls to new API and store some dummy data

ex7 issues

Ensure that you are in the LoopBack directory you created in Exercise 2

2 or 3?

GET /Employees

You might get a CORS error. Please override the CORS error as suggested in exercise 2.

I got a preflow error but eventually got since there is not step that populates the database I think @svennam92 and @joshisa - you both need to work that out.

{
"error": {
"name": "Error",
"status": 500,
"message": "ER_NO_SUCH_TABLE: Table 'ad_a0b3c7926397d25.employees' doesn't exist",
"code": "ER_NO_SUCH_TABLE",
"errno": 1146,
"sqlState": "42S02",
"index": 0,
"stack": "Error: ER_NO_SUCH_TABLE: Table 'ad_a0b3c7926397d25.employees' doesn't exist\n at Query.Sequence._packetToError (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/sequences/Sequence.js:51:14)\n at Query.ErrorPacket (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/sequences/Query.js:83:18)\n at Protocol._parsePacket (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/Protocol.js:280:23)\n at Parser.write (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/Parser.js:74:12)\n at Protocol.write (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/Protocol.js:39:16)\n at Socket. (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/Connection.js:109:28)\n at emitOne (events.js:96:13)\n at Socket.emit (events.js:188:7)\n at readableAddChunk (_stream_readable.js:176:18)\n at Socket.Readable.push (_stream_readable.js:134:10)\n --------------------\n at Protocol._enqueue (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/protocol/Protocol.js:141:48)\n at PoolConnection.query (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/Connection.js:214:25)\n at Object.eval [as forward](eval at recompile %28/usr/local/lib/node_modules/apiconnect/node_modules/strong-agent/lib/proxy.js:251:15%29, :4:32)\n at PoolConnection.query (eval at wrap (/usr/local/lib/node_modules/apiconnect/node_modules/strong-agent/lib/proxy.js:207:20), :3:21)\n at runQuery (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/loopback-connector-mysql/lib/mysql.js:183:16)\n at executeWithConnection (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/loopback-connector-mysql/lib/mysql.js:225:7)\n at Handshake.onConnect (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/mysql/lib/Pool.js:63:7)\n at Handshake. (/Users/srinir16/ibm/HOLs/apichol/exercises/ex4/loopbackapp/node_modules/continuation-local-storage/context.js:84:17)\n at bound (domain.js:280:14)\n at Handshake.runBound as _callback"
}
}

Same with PUT as well.

Cannot seem to find employeeAPI (other apps are listed) as in the instructions. Do we need to push this separately? Was this step missed?

Various issues with ex4

First off, like your style of instructions. It seems very conversational.

Here's the yeah but (all rolled into one, hope you don't mind).

I never quite got connection of using the in-memory db. Does the javascript use the in memory db somewhere?

Some instructions are missing (like cd loopbackapp). In general, more instructions are better than assuming the attendees might know it (for example, not always is that hit on the process in the terminal window to terminate the process is included. It's there in some cases, not always).

Also you might want to ask attendees to cp the swagger.json to loopbackapp directory and kinda look at it and explain some salient parts (perhaps).

I am not sure looking at the JSON if it's calling the localhost or Bluemix.

The Models tab does not appear on Chrome. Seems fine on Safari and Firefox (but Firefox is slow).

The response to (at end)
http://localhost:3000/api/api/v1/mac/2
was a

{
"mac": null
}

I don't think it's correct and probably not a good idea to get back a null anyway?

Again, the no login apic edit might be better?

Issues with Exercise 5 and 6

The standalone exercise 5 needs to be better integrated. Using a service is great, but, perhaps the goal here is

You might have an existing Data source that you want to front end with APIs, let's start by populating a data source - Employees in this exercise (exercise 5) an then make the data available via APIs, blah blah ...

I am hoping that the population can be done via Java/JDBC (our 24x7 HA application :-)).

ex3 hangs

Ex3 works fine on mac but hangs when importing JSON in the Oracle VM. Can you please try on another Linux VM?

ex8 issues

Looks very straightforward except that I have not been able to complete 7 (yet).

Exercise: Create an API for MySQL/DB2 access with API Designer

npm install -g apiconnect
apic loopback
apic edit
create model
create database connection
explore APIs locally

Problems with Bluemix login - ex6

I tried this again and don't seem to be able to login via my Bluemix creds. I use my creds and I see this window and that's it.

We need to fix this ASAP (preferred) or find a workaround (acceptable).

Same results with different browsers.

ex8 issues

{
"httpCode": "500",
"httpMessage": "URL Open error",
"moreInformation": "Could not connect to endpoint"
}

This might be because the table is non-existent. However, we need to verify this.

Exercise: Deploy newly created APIs using Java Best Practice API tooling

• Create APIs using current best practice for Java Dev
• Deploy on to Bluemix
• Use API Connect to marry with APIs
• Should we look at the API gateway pattern as well (or is it orthogonal?)

Formatting issue?

Not sure if this is a formatting issue (or the intention of this?)

at

https://github.com/ragsns/apichol/tree/master/exercises/ex3

and

OpenAPI removes the guesswork in calling the service

Formatting could be improved?

Flow

We need to look at the flow again once the exercises are better fleshed out but they seem to flow OK. Some repetitions which is good and a gradual progression.

In general within an exercise, we have to follow the cliched "say what we will say, say it, say what we said".

We also need to connect exercises.

Can we all try to look at our exercises and try to improve the intra exercise flow, inter-exercise flow, etc.?

Empathy Map / Pain Points experienced by attendees

Not sure if these are right, but starting a list

• Learn about IBM API Connect Cloud Capabilities, concepts and tooling
• Learn the basics around how to use API connect to manage APIs that I do & do not control
• Learn the basics around how to use API connect to integrate with APIs that I do not control
• Learn what Swagger is, how it helps me, what tooling support is available and best practices around its definition.
• Learn about an API lifecycle and why it is important
• Learn about common API problems and how to address them
• Learn about API considerations in the context of hybrid cloud (on-prem + off-prem)

Lab preamble

We will do a short presentation and demo. (max of 15-18 mins.) and turn the attendees loose after that.

Presentation should cover local apic, apic manager on Bluemix, API developer portal, plans, analytics, etc. and the relationship between all this.

Pre-assigned Bluemix accounts?

Can we have some accounts in our back pocket just in case?

Microservices

We are positioning API Connect for Microservices at JavaOne in general.
Should we try and cover the value of API C vis-a-vis a micro service example?

Java

Java connection is at best tenuous. Not sure if we can fix this but let's brainstorm a bit more?

ex3

one section is labeled: LoopBack API using API Designer

However, it's not a LoopBack API, simply an Open API spec explorer and designer. LoopBack only applies when we connect the APIs to a LoopBack Node.js back-end, which we do in the next exercise.

After this exercise, you kind of think... "what was the point". It may be worth leading the user into the next step. Exercise 3 was simple api designing and management -- you need to create the backend yourself. So in exercise 4, we create that backend.

Could make a note that if you already have the backend, you could publish the swagger spec to Bluemix, where it would simply manage your existing APIs, like a typical API Management solution. Bluemix would provide analytics, gateway, security, authentication and user management.

empty file in this folder prevents `apic loopback` from working

can't have a .ignore file in here:
https://github.com/ragsns/apichol/tree/master/exercises/ex4/loopbackapp

Loopback complains that it needs an empty folder for the apic loopback command.

apic edit is mangled on firefox browser on Oracle Linux

Workaround is to use Chrome.

grep -i proxy /etc/wgetrc

If you do not want to use proxy at all, set this to off.

use_proxy = off

wget http://chrome.richardlloyd.org.uk/install_chrome.sh
chmod +x install_chrome.sh
./install_chrome.sh

and make Chrome the default browser.

I won't close this until we've updated the VM and verified it.

Improve the PDF Generation?

There is a section in the .md of exercise 3 which has

Browse to the spec. of the section that looks similar to:

The

...

fragment is skipped.

Workaround: Use the github URL in browser.

Or

a. option in pandoc to include the code in the

 ... 

blocks.
b. Screenshot it

I prefer b. But we need to find solution for a as well.