Fix issues in current Getting Started documentation.

[isamauny-wso2]

Description:

1. Remove references to Oracle JDK and replace with OpenJDK / Telerium JDK
2. Use JDK 22 instead of JDK 17
3. Guide users through creating a simple mock in Mocky.io
4. Test API first in API Designer
5. Leverage default application for Portal test (no need to create a new one)

Suggested Labels:
getting-started, improvement

Suggested Assignees:

Affected Product Version: 4.4 / 4.3 / 4.2

Related Issues:

[ashera96]

We have revamped the quick start guide. Please find the PRs mentioned below:

Master

• Update Quick Start Guide #8715

4.4.0

• Update Quick Start Guide #8652
• [4.4.0] Update Quick Start Guide #8711

4.3.0

• [4.3.0] Update Quick Start Guide  #8742

[ashera96]

Hi @isamauny-wso2,

Regarding the below comment:

Points 4 and 5 have not been addressed. No need to get people to create an application.

Test API first in API Designer
This becomes a redundant step since the person who is following along the guide will anyway get the opportunity to try out the API invocation by the end of the tutorial. Don't we end up lengthening the quick start guide if we were to do this? Please share your thoughts on the above point.

Leverage default application for Portal test (no need to create a new one)
We have already done this change via the abovementioned PRs.

You can find the updated quick start guide at [1]. Please share your thoughts on the revamped guide.

1. https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/

[isamauny-wso2]

So those are different steps
a- I want as a dev to test the API I am planning to expose works (as a developer, I want to test the API before publishing it) - That's my step 4
b- We want to show the consumer experience - That's step 5 (as a consumer, I subscribe and test). And there we should use the default application.

We can add b- as an extra step to the GS , no problem there.

Hi @isamauny-wso2,

Regarding the below comment:

Points 4 and 5 have not been addressed. No need to get people to create an application.

Test API first in API Designer This becomes a redundant step since the person who is following along the guide will anyway get the opportunity to try out the API invocation by the end of the tutorial. Don't we end up lengthening the quick start guide if we were to do this? Please share your thoughts on the above point.

Leverage default application for Portal test (no need to create a new one) We have already done this change via the abovementioned PRs.

You can find the updated quick start guide at [1]. Please share your thoughts on the revamped guide.

1. https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/

[ashera96]

Hi @isamauny-wso2,

I agree; what you are suggesting makes sense.

I want as a dev to test the API I am planning to expose works (as a developer, I want to test the API before publishing it) - That's my step 4

So it makes sense to let the developer try out the API before publishing. But we create and publish in a single step. (refer to step 6 under [1]).

However, we have the option to take the long route here (create as the first step, then deploy, test and finally publish to the developer portal). This would make sense in terms of getting a userstory across; an API designer/developer creates and deploys the API, an API publisher publishes it, and an API consumer consumes it via the Developer portal. This would make the QSG lengthier, but of course, much more clearer. However, note that it won't be the quickest way to get someone to try out an API.

I shall fix the QSG based on your feedback. Thanks in advance :)

[1] https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/#step-1-create-deploy-and-publish-an-api

[ashera96]

Closing this issue due to inactivity. Feel free to reopen if the QSG needs to be revamped.