search

alexa / alexa-skills-kit-sdk-for-nodejs

The Alexa Skills Kit SDK for Node.js helps you get a skill up and running quickly, letting you focus on skill logic instead of boilerplate code.
Apache License 2.0
3.13k stars 737 forks source link

Example/clarify documentation over "withApiClient" #415

Closed alopix closed 6 years ago

alopix commented 6 years ago

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[x] Documentation issue or request
[ ] Other... Please describe:

Expected Behavior

The documentation about the ApiClient is basically non-existent but is something very simple to add.

Current Behavior

Currently the page asks you to take a look at another page to configure the ApiClient in order to use the ServiceClientFactory:. "The ServiceClientFactory are only available when you configure the skill instance with an ApiClient." On that page there's no information how to configure it. It only shows, there's a withApiClient function but no hint where the standard ApiClient can be found.

Possible Solution

As the setup is really simple for the default ApiClient but hard to figure out without stumbling across one sample project, I think it might be useful for developers to add, that there's a DefaultApiClient class available: new Alexa.DefaultApiClient()

tianrenz commented 6 years ago

Hi @alopix ,

Thanks for your support of ASK SDK. We've made some updates to our documentation. You can find them here. Please let us know if you have any more issues. Or submit a pull request :D

Regards