How to add API Reference to REST SOE Methods

IevgeniiSiroklyn — Thu, 23 Feb 2017 21:06:13 GMT

Hi!

We have implemented SOE and it works fine.

We implemented IRESTRequestHandler interface for our extension, and we receive and processing requests with method from IRESTRequestHandler interface:

[C#]public Byte[] HandleRESTRequest (    string Capabilities,    string resourceName,    string operationName,    string operationInput,    string outputFormat,    string requestProperties,    ref string responseProperties);

Now we want to show API Reference for our REST API methods, like it does ESRI. So when user clicks on "Api Reference" link in the top right corner we want to generate and show html help page for correspond extension method (description and examples of parameters, return values, ...)

We noticed that this "API Reference" has always the same format:

https://<host>/<arcgis_instance>/rest/services/<service>/MapServer/exts/<extension_name>/MethodName?f=help

We assume that we should receive requests to IRESTRequestHandler with OutputFormat="help", but we do not receive any requests with f=help, it looks like all such requests are intercepted by arcgis server, and it redirects user to ESRI API reference, which of course does not includes help for our extension methods. So basically we don't have control over any request with f=help. (We successfully receiving all other requests like f=test, f=help1, f=whatever, .... but NOT f=help)

So i wanted to ask is there any way to handle requests with "help" output format ("f=help") Or maybe we need to change some arcgis server/service property in order to handle such requests? Or maybe there is some another approach to show help for SOE extension methods. We want to be consistent with ESRI, so ideally it would be good if we could show help for our methods in the same format as ESRI.

Thanks.

Re: How to add API Reference to REST SOE Methods

nicogis — Wed, 08 Mar 2017 08:36:06 GMT

Seems an implementation not exposed so you could publish it as an idea https://community.esri.com/community/arcgis-ideas/

topic Re: How to add API Reference to REST SOE Methods in ArcGIS Enterprise Extensibility Questions

How to add API Reference to REST SOE Methods

Re: How to add API Reference to REST SOE Methods