guzzle-services icon indicating copy to clipboard operation
guzzle-services copied to clipboard

Where did the documentation go?

Open dragonwize opened this issue 9 years ago • 14 comments

I wrote code using Guzzle 4 services about 6 months ago and used documentation of the service description array options, however, I now can no longer find this documentation any where.

Where is the documentation for the description array options?

dragonwize avatar Feb 05 '15 18:02 dragonwize

There aren't any docs yet, and this repo isn't yet stable. I'm hoping to get guzzlehttp/command tagged stable soon, thoroughly document it, then come back to guzzlehttp/guzzle-services to write more docs.

mtdowling avatar Feb 05 '15 18:02 mtdowling

I realize the code could can change, and am will to accept that. I have used this code successfully in the past and remember specifically reading about the different options in the service description such "extends", "$ref", etc.

I believe it was on the old guzzlephp site, if I remember correctly. However, the site is now completely different and archive.org has been no help as I think the URLs have changed and there is only sporadic crawls.

Does this documentation not exist anymore?

dragonwize avatar Feb 05 '15 18:02 dragonwize

The Guzzle 3 documentation is hosted at http://guzzle3.readthedocs.org/webservice-client/guzzle-service-descriptions.html. The docs here are going to differ in many ways from this repo (and the rest of the docs differ quite a bit from Guzzle 5).

mtdowling avatar Feb 05 '15 18:02 mtdowling

+1 on docs, I cannot figure out why I'm receiving no data back from a simple GET request to httpbin.org

For reference, here's the JSON schema:

{
    "name": "httpbin",
    "baseUrl": "http://httpbin.org",
    "operations": {
        "html": {
            "httpMethod": "GET",
            "uri": "/html"
        }
    }
}

hassankhan avatar Mar 18 '15 22:03 hassankhan

You need to define the response model. Here is an example (in PHP array notation):

https://github.com/Rarst/wporg-client/blob/33fb0dcce9f170b92824d09f5717ca814d7ecd29/php/WporgService.php

shirshir avatar Mar 19 '15 09:03 shirshir

Thank you so much!!

hassankhan avatar Mar 19 '15 14:03 hassankhan

Any docs coming soon?

eddiejaoude avatar May 23 '15 22:05 eddiejaoude

@mtdowling same doubt. thx

richhl avatar Jul 06 '15 08:07 richhl

Any update on this?

cryptiklemur avatar Mar 15 '16 01:03 cryptiklemur

Soon they said. 2 years ago.

Guibod avatar Nov 02 '17 15:11 Guibod

We are using Guzzle services successfully for a few years now and I thought to upgrade it, because version 3.5 is very outdated, you have Guzzle 6 now. Composer is warning me any time that "Package guzzle/guzzle is abandoned, you should avoid using it. Use guzzlehttp/guzzle instead." So I decided to upgrade to 6, or, well, to version 5. So far so good.

The problems start when I want to migrate my services. Packages and namespaces are gone, there is no Guzzle/Service/Command/ResponseClassInterface, for example and, although there is a Migration Guide, I found NOT A WORD about new guzzle services! Was hoping to find an API reference, at least, but nothing! Are you serious? How do you imagine people will migrate their web services code??

I understand that most people use Guzzle for HTTP, but still it's not only for this. If you don't have the resources to write a proper doc, please don't upgrade the code. I am now looking to go back to Guzzle 3.*, hope to work with the other upgraded libraries.

A shame and too bad for such a good library.

gkzsolt avatar Jan 18 '18 16:01 gkzsolt

@gkzsolt same here, I'm pulling my hair out looking for something about that ResponseClassInterface. I can't find anything. In the upgrade guide from 3 to 4 they're mentioning methods that are gone in v4.

cdarken avatar Jun 21 '18 10:06 cdarken

Use the source, Luke.

tlorens avatar Jan 28 '19 14:01 tlorens

There aren't any docs yet, and this repo isn't yet stable. I'm hoping to get guzzlehttp/command tagged stable soon, thoroughly document it, then come back to guzzlehttp/guzzle-services to write more docs.

Is it now 2021 and the document has not been updated yet?

moniang avatar Feb 24 '21 02:02 moniang