[mapguide-users] HttpApi doc improvement

[Jackie Ng]

Ok, if you or anyone else up to it:

The HTTP API handler source code is here:

http://trac.osgeo.org/mapguide/browser/trunk/MgDev/Web/src/HttpHandler

The master list of operations is defined here:

http://trac.osgeo.org/mapguide/browser/trunk/MgDev/Web/src/HttpHandler/HttpRequest.cpp#L344

Operation names and parameter names are referenced via this string bundle
(you really only care about ones starting with "op" for operation names and
"req" for request parameters):

http://trac.osgeo.org/mapguide/browser/trunk/MgDev/Web/src/HttpHandler/HttpResourceStrings.cpp

Then implementations of each operation exists in a file of the form
Http{OperationName}.cpp

If you look at any of these files, they all follow a similar pattern:

 - They read in parameter values from the class constructor. That's where
you can identify the names and values of the parameters used by this
operation
 - They all ultimately call into some existing MapGuide API when executing,
so you can cross reference with the official MapGuide API documentation to
find out the description and purpose of any parameters.
 - Some operations perform version checks in validation and some during
execution. That's where you can identify how many different versions of this
operation exist and what versions that certain parameters are applicable
for. For operations that don't validate or check for any versions, you can
assume "1.0.0"

Hope that helps.

- Jackie



--
View this message in context: http://osgeo-org.1560.x6.nabble.com/HttpApi-doc-improvement-tp5302731p5303020.html
Sent from the MapGuide Users mailing list archive at Nabble.com.