Auto documenting REST API in PHP

php rest documentation-generation
Greywire picture Greywire · Mar 15, 2011 · Viewed 43.6k times · Source

phpDocumentor seems to be the standard for documenting PHP code, though I have to wonder why it hasn't been updated in years..?

However, it does not seem suitable for documenting the entry points for a REST API; IE, externally accessible entry points that an end user of your system would be interested in, as opposed to documenting all the internal classes and such - something only of interest to the developers of the api.

I am looking for something where I could say, hey this method here is externally accessible through REST at this URL, here's the GET or POST arguments it takes, it supports GET/POST/etc HTTP methods, it returns JSON or XML or whatever.

This information would be able to produce an API document. It could also be used by the code internally to automatically filter inputs, validate output, create basic unit tests, etc.

Answer

fehguy picture fehguy · Aug 30, 2012

I know of 3 PHP integrations with swagger:

All should help auto-create a swagger-spec, which gives you access from swagger-ui. Then you can generate api clients, etc.

Related questions

Call a REST API in PHP

Our client had given me a REST API to which I need to make a PHP call to. But as a matter of fact the documentation given with the API is very limited, so I don't really know how to …

Read More
How do I make a request using HTTP basic authentication with PHP curl?

I'm building a REST web service client in PHP and at the moment I'm using curl to make requests to the service. How do I use curl to make authenticated (http basic) requests? Do I have to add the headers …

Read More
How to POST JSON Data With PHP cURL?

Here is my code, $url = 'url_to_post'; $data = array( "first_name" => "First name", "last_name" => "last name", "email"=>"[email protected]", "addresses" => array ( "address1" => "some address", "city" => "city", "country" => "CA", "first_name" =&…

Read More