You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@griffin.apache.org by Artem Shutak <ar...@gmail.com> on 2018/09/12 09:22:03 UTC

griffin-docker-guide. How to use postman?

Hello!

I'm following
https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md
to get started with Apache Griffin.

I stuck at point 3 of
https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md#how-to-use-griffin-docker-images-in-batch-mode.
Could you please explain what does "importing the json files" mean in "Now
you can try griffin APIs by using postman after importing the json files"?
What does it mean "to import" files here? I guess to put in some folder.
But which one. How to say Griffin where it should look for the files?

Thanks,
Artem.

Re: griffin-docker-guide. How to use postman?

Posted by Lionel Liu <li...@apache.org>.
Hi Artem,

Thanks for your suggestion. I agree with you, the link of postman seems
necessary.
For the default value of BASE_PATH, if the user is using docker at
localhost, it's OK to set it as localhost:38080, but if he's using a remote
machine as docker host, the ip address would be unknown. I think it's OK to
modify the default value to localhost:38080, but in document we still need
to remind user the potential modification.

Thanks,
Lionel

On Wed, Sep 12, 2018 at 8:14 PM Artem Shutak <ar...@gmail.com> wrote:

> Hello, Lionel,
>
> Thank you for your response.
>
> Yes, I saw the link. My problem was I did't know what postman is. I guess
> it is this one: https://www.getpostman.com/apps.
> Not everyone knows what postman is (I just guess I'm not alone :) ) and it
> would be useful to have a link in documentation.
>
> Another issue I see that postman configuration sets BASEPATH to
> localhost:8080, but my application started using port 38080. Yes, I see "In
> which you need to modify the environment BASE_PATH value to <your local IP
> address>:38080", but it's not obvious for me  that I need to change port
> (38080 and 8080 looks quite similar).
> Is it possible to change postman configuration (
> https://github.com/apache/incubator-griffin/blob/master/griffin-doc/service/postman/griffin_environment.json#L8)
> to make it work out-of-the-box or is it done on purpose?
>
> I know that it's small things, but I would like to make getting started
> guide as simple and clear as possible.
>
> If you agree I can create a PR with proper changes.
>
> Thanks,
> Artem.
>
> 2018-09-12 12:59 GMT+03:00 Lionel Liu <li...@apache.org>:
>
>> Hi Artem,
>>
>> There's a link at the "json files" word, by clicking it you'll be
>> redirected to the json files link:
>> https://github.com/apache/incubator-griffin/tree/master/griffin-doc/service/postman
>> Those two json files can be imported into postman, then you can try the
>> APIs of griffin server.
>>
>> Thanks,
>> Lionel
>>
>> On Wed, Sep 12, 2018 at 5:22 PM Artem Shutak <ar...@gmail.com>
>> wrote:
>>
>>> Hello!
>>>
>>> I'm following
>>> https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md
>>> to get started with Apache Griffin.
>>>
>>> I stuck at point 3 of
>>> https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md#how-to-use-griffin-docker-images-in-batch-mode.
>>> Could you please explain what does "importing the json files" mean in
>>> "Now you can try griffin APIs by using postman after importing the json
>>> files"? What does it mean "to import" files here? I guess to put in some
>>> folder. But which one. How to say Griffin where it should look for the
>>> files?
>>>
>>> Thanks,
>>> Artem.
>>>
>>
>

Re: griffin-docker-guide. How to use postman?

Posted by Artem Shutak <ar...@gmail.com>.
Hello, Lionel,

Thank you for your response.

Yes, I saw the link. My problem was I did't know what postman is. I guess
it is this one: https://www.getpostman.com/apps.
Not everyone knows what postman is (I just guess I'm not alone :) ) and it
would be useful to have a link in documentation.

Another issue I see that postman configuration sets BASEPATH to
localhost:8080, but my application started using port 38080. Yes, I see "In
which you need to modify the environment BASE_PATH value to <your local IP
address>:38080", but it's not obvious for me  that I need to change port
(38080 and 8080 looks quite similar).
Is it possible to change postman configuration (
https://github.com/apache/incubator-griffin/blob/master/griffin-doc/service/postman/griffin_environment.json#L8)
to make it work out-of-the-box or is it done on purpose?

I know that it's small things, but I would like to make getting started
guide as simple and clear as possible.

If you agree I can create a PR with proper changes.

Thanks,
Artem.

2018-09-12 12:59 GMT+03:00 Lionel Liu <li...@apache.org>:

> Hi Artem,
>
> There's a link at the "json files" word, by clicking it you'll be
> redirected to the json files link: https://github.com/
> apache/incubator-griffin/tree/master/griffin-doc/service/postman
> Those two json files can be imported into postman, then you can try the
> APIs of griffin server.
>
> Thanks,
> Lionel
>
> On Wed, Sep 12, 2018 at 5:22 PM Artem Shutak <ar...@gmail.com>
> wrote:
>
>> Hello!
>>
>> I'm following https://github.com/apache/incubator-griffin/blob/
>> master/griffin-doc/docker/griffin-docker-guide.md to get started with
>> Apache Griffin.
>>
>> I stuck at point 3 of https://github.com/apache/
>> incubator-griffin/blob/master/griffin-doc/docker/griffin-
>> docker-guide.md#how-to-use-griffin-docker-images-in-batch-mode. Could
>> you please explain what does "importing the json files" mean in "Now you
>> can try griffin APIs by using postman after importing the json files"? What
>> does it mean "to import" files here? I guess to put in some folder. But
>> which one. How to say Griffin where it should look for the files?
>>
>> Thanks,
>> Artem.
>>
>

Re: griffin-docker-guide. How to use postman?

Posted by Lionel Liu <li...@apache.org>.
Hi Artem,

There's a link at the "json files" word, by clicking it you'll be
redirected to the json files link:
https://github.com/apache/incubator-griffin/tree/master/griffin-doc/service/postman
Those two json files can be imported into postman, then you can try the
APIs of griffin server.

Thanks,
Lionel

On Wed, Sep 12, 2018 at 5:22 PM Artem Shutak <ar...@gmail.com> wrote:

> Hello!
>
> I'm following
> https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md
> to get started with Apache Griffin.
>
> I stuck at point 3 of
> https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md#how-to-use-griffin-docker-images-in-batch-mode.
> Could you please explain what does "importing the json files" mean in
> "Now you can try griffin APIs by using postman after importing the json
> files"? What does it mean "to import" files here? I guess to put in some
> folder. But which one. How to say Griffin where it should look for the
> files?
>
> Thanks,
> Artem.
>